Cisco-IOS-XR-ipv4-igmp-cfg API API Reference

API generated from Cisco-IOS-XR-ipv4-igmp-cfg@2017-10-15.yang

API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
   Key  Mandatory  Optional

Paths

IGMP - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/

Update operation of resource: igmp

igmp_schema

igmpbody object

Request Content-Types: application/json
Request Example
{
  : {
IGMPconfigurationPUTPOSTDELETEGET
    : {
VRF related configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Inheritable DefaultsPUTPOSTDELETEGET
            
"access-group": "string", Access list specifying access group range
            : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
              
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

              
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

              
"access-list-name": "string" Access-list to account for

            },
            : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
              
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

              
"access-list-name": "string" Access-list to account for

            },
            
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

            
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

            
"version": "integer", Version number
range: "1..3"
default: "3"

            
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

            
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

          },
          : {
IGMP Source specific modePUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"access-list-name": "string", Access-list to account for

                
"source-address": "string" IP source address

              }
            ]
          },
          
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

          
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
          : {
Configure IGMP State LimitsPUTPOSTDELETEGET
            
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          },
          
"vrf-name": "string", Name for this vrf
          : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
            
"profile": "string" Configure the route-policy profile

          },
          : {
Interface-level configurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"access-group": "string", Access list specifying access group range

                
"interface-name": "string", Name of the interface
                : {
IGMP join multicast groupPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"group-address": "string", IP group address

                      
"mode": "string" Filter mode

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-address": "string", IP group address

                      
"mode": "string", Filter mode

                      
"source-address": "string" IP source address

                    }
                  ]
                },
                : {
IGMP static multicast groupPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"group-address-mask": "string", Mask for Group Address

                      
"group-address": "string", IP group address

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"source-address": "string", IP source address

                      
"group-address-mask": "string", Mask for Group Address

                      
"source-address-mask": "string", Mask for Source Address

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"group-address": "string", IP group address

                      
"source-address": "string", IP source address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"source-address": "string", IP source address

                      
"group-address-mask": "string", Mask for Group Address

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"source-address": "string", IP source address

                      
"source-address-mask": "string", Mask for Source Address

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ]
                },
                
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
                : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
                  
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

                  
"access-list-name": "string" Access-list to account for

                },
                
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
                : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
                  
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

                  
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

                  
"access-list-name": "string" Access-list to account for

                },
                
"version": "integer", Version number
range: "1..3"
default: "3"

                
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

                
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

              }
            ]
          }
        }
      ]
    },
    : {
Default ContextPUTPOSTDELETEGET
      : {
Inheritable DefaultsPUTPOSTDELETEGET
        
"access-group": "string", Access list specifying access group range
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      },
      : {
Configure IGMP QoS shapers for subscriber\ninterfacesPUTPOSTDELETEGET
        
"download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"

        
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"

        
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"

      },
      : {
IGMP Source specific modePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-list-name": "string", Access-list to account for

            
"source-address": "string" IP source address

          }
        ]
      },
      
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

      
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
      : {
Configure IGMP State LimitsPUTPOSTDELETEGET
        
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      },
      : {
Configure NSF specific optionsPUTPOSTDELETEGET
        
"lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"

      },
      : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
        
"profile": "string" Configure the route-policy profile

      },
      : {
Configure IGMP accounting for logging\njoin/leave recordsPUTPOSTDELETEGET
        
"max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"

      },
      : {
Interface-level configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-group": "string", Access list specifying access group range

            
"interface-name": "string", Name of the interface
            : {
IGMP join multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string" Filter mode

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string", Filter mode

                  
"source-address": "string" IP source address

                }
              ]
            },
            : {
IGMP static multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"source-address": "string", IP source address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ]
            },
            
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
            : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
              
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

              
"access-list-name": "string" Access-list to account for

            },
            
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
            : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
              
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

              
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

              
"access-list-name": "string" Access-list to account for

            },
            
"version": "integer", Version number
range: "1..3"
default: "3"

            
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

            
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

          }
        ]
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IGMP - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/

Create operation of resource: igmp

igmp_schema

igmpbody object

Request Content-Types: application/json
Request Example
{
  : {
IGMPconfigurationPUTPOSTDELETEGET
    : {
VRF related configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Inheritable DefaultsPUTPOSTDELETEGET
            
"access-group": "string", Access list specifying access group range
            : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
              
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

              
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

              
"access-list-name": "string" Access-list to account for

            },
            : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
              
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

              
"access-list-name": "string" Access-list to account for

            },
            
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

            
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

            
"version": "integer", Version number
range: "1..3"
default: "3"

            
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

            
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

          },
          : {
IGMP Source specific modePUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"access-list-name": "string", Access-list to account for

                
"source-address": "string" IP source address

              }
            ]
          },
          
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

          
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
          : {
Configure IGMP State LimitsPUTPOSTDELETEGET
            
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          },
          
"vrf-name": "string", Name for this vrf
          : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
            
"profile": "string" Configure the route-policy profile

          },
          : {
Interface-level configurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"access-group": "string", Access list specifying access group range

                
"interface-name": "string", Name of the interface
                : {
IGMP join multicast groupPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"group-address": "string", IP group address

                      
"mode": "string" Filter mode

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-address": "string", IP group address

                      
"mode": "string", Filter mode

                      
"source-address": "string" IP source address

                    }
                  ]
                },
                : {
IGMP static multicast groupPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"group-address-mask": "string", Mask for Group Address

                      
"group-address": "string", IP group address

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"source-address": "string", IP source address

                      
"group-address-mask": "string", Mask for Group Address

                      
"source-address-mask": "string", Mask for Source Address

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"group-address": "string", IP group address

                      
"source-address": "string", IP source address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"source-address": "string", IP source address

                      
"group-address-mask": "string", Mask for Group Address

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"source-address": "string", IP source address

                      
"source-address-mask": "string", Mask for Source Address

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ]
                },
                
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
                : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
                  
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

                  
"access-list-name": "string" Access-list to account for

                },
                
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
                : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
                  
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

                  
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

                  
"access-list-name": "string" Access-list to account for

                },
                
"version": "integer", Version number
range: "1..3"
default: "3"

                
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

                
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

              }
            ]
          }
        }
      ]
    },
    : {
Default ContextPUTPOSTDELETEGET
      : {
Inheritable DefaultsPUTPOSTDELETEGET
        
"access-group": "string", Access list specifying access group range
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      },
      : {
Configure IGMP QoS shapers for subscriber\ninterfacesPUTPOSTDELETEGET
        
"download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"

        
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"

        
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"

      },
      : {
IGMP Source specific modePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-list-name": "string", Access-list to account for

            
"source-address": "string" IP source address

          }
        ]
      },
      
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

      
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
      : {
Configure IGMP State LimitsPUTPOSTDELETEGET
        
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      },
      : {
Configure NSF specific optionsPUTPOSTDELETEGET
        
"lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"

      },
      : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
        
"profile": "string" Configure the route-policy profile

      },
      : {
Configure IGMP accounting for logging\njoin/leave recordsPUTPOSTDELETEGET
        
"max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"

      },
      : {
Interface-level configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-group": "string", Access list specifying access group range

            
"interface-name": "string", Name of the interface
            : {
IGMP join multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string" Filter mode

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string", Filter mode

                  
"source-address": "string" IP source address

                }
              ]
            },
            : {
IGMP static multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"source-address": "string", IP source address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ]
            },
            
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
            : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
              
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

              
"access-list-name": "string" Access-list to account for

            },
            
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
            : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
              
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

              
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

              
"access-list-name": "string" Access-list to account for

            },
            
"version": "integer", Version number
range: "1..3"
default: "3"

            
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

            
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

          }
        ]
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IGMP - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/

Delete operation of resource: igmp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IGMP - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/

Retrieve operation of resource: igmp

200 OK
igmp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMPconfigurationPUTPOSTDELETEGET
    : {
VRF related configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Inheritable DefaultsPUTPOSTDELETEGET
            
"access-group": "string", Access list specifying access group range
            : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
              
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

              
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

              
"access-list-name": "string" Access-list to account for

            },
            : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
              
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

              
"access-list-name": "string" Access-list to account for

            },
            
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

            
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

            
"version": "integer", Version number
range: "1..3"
default: "3"

            
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

            
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

          },
          : {
IGMP Source specific modePUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"access-list-name": "string", Access-list to account for

                
"source-address": "string" IP source address

              }
            ]
          },
          
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

          
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
          : {
Configure IGMP State LimitsPUTPOSTDELETEGET
            
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          },
          
"vrf-name": "string", Name for this vrf
          : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
            
"profile": "string" Configure the route-policy profile

          },
          : {
Interface-level configurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"access-group": "string", Access list specifying access group range

                
"interface-name": "string", Name of the interface
                : {
IGMP join multicast groupPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"group-address": "string", IP group address

                      
"mode": "string" Filter mode

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-address": "string", IP group address

                      
"mode": "string", Filter mode

                      
"source-address": "string" IP source address

                    }
                  ]
                },
                : {
IGMP static multicast groupPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"group-address-mask": "string", Mask for Group Address

                      
"group-address": "string", IP group address

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"source-address": "string", IP source address

                      
"group-address-mask": "string", Mask for Group Address

                      
"source-address-mask": "string", Mask for Source Address

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"group-address": "string", IP group address

                      
"source-address": "string", IP source address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"source-address": "string", IP source address

                      
"group-address-mask": "string", Mask for Group Address

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"source-address": "string", IP source address

                      
"source-address-mask": "string", Mask for Source Address

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ]
                },
                
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
                : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
                  
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

                  
"access-list-name": "string" Access-list to account for

                },
                
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
                : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
                  
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

                  
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

                  
"access-list-name": "string" Access-list to account for

                },
                
"version": "integer", Version number
range: "1..3"
default: "3"

                
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

                
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

              }
            ]
          }
        }
      ]
    },
    : {
Default ContextPUTPOSTDELETEGET
      : {
Inheritable DefaultsPUTPOSTDELETEGET
        
"access-group": "string", Access list specifying access group range
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      },
      : {
Configure IGMP QoS shapers for subscriber\ninterfacesPUTPOSTDELETEGET
        
"download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"

        
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"

        
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"

      },
      : {
IGMP Source specific modePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-list-name": "string", Access-list to account for

            
"source-address": "string" IP source address

          }
        ]
      },
      
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

      
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
      : {
Configure IGMP State LimitsPUTPOSTDELETEGET
        
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      },
      : {
Configure NSF specific optionsPUTPOSTDELETEGET
        
"lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"

      },
      : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
        
"profile": "string" Configure the route-policy profile

      },
      : {
Configure IGMP accounting for logging\njoin/leave recordsPUTPOSTDELETEGET
        
"max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"

      },
      : {
Interface-level configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-group": "string", Access list specifying access group range

            
"interface-name": "string", Name of the interface
            : {
IGMP join multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string" Filter mode

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string", Filter mode

                  
"source-address": "string" IP source address

                }
              ]
            },
            : {
IGMP static multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"source-address": "string", IP source address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ]
            },
            
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
            : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
              
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

              
"access-list-name": "string" Access-list to account for

            },
            
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
            : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
              
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

              
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

              
"access-list-name": "string" Access-list to account for

            },
            
"version": "integer", Version number
range: "1..3"
default: "3"

            
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

            
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

          }
        ]
      }
    }
  }
}

VRFS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/

Update operation of resource: vrfs

vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : {
VRF related configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Inheritable DefaultsPUTPOSTDELETEGET
          
"access-group": "string", Access list specifying access group range
          : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
            
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

            
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

            
"access-list-name": "string" Access-list to account for

          },
          : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
            
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

            
"access-list-name": "string" Access-list to account for

          },
          
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

          
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

          
"version": "integer", Version number
range: "1..3"
default: "3"

          
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

          
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

        },
        : {
IGMP Source specific modePUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"access-list-name": "string", Access-list to account for

              
"source-address": "string" IP source address

            }
          ]
        },
        
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

        
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
        : {
Configure IGMP State LimitsPUTPOSTDELETEGET
          
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        },
        
"vrf-name": "string", Name for this vrf
        : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
          
"profile": "string" Configure the route-policy profile

        },
        : {
Interface-level configurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"access-group": "string", Access list specifying access group range

              
"interface-name": "string", Name of the interface
              : {
IGMP join multicast groupPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"group-address": "string", IP group address

                    
"mode": "string" Filter mode

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-address": "string", IP group address

                    
"mode": "string", Filter mode

                    
"source-address": "string" IP source address

                  }
                ]
              },
              : {
IGMP static multicast groupPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"group-address-mask": "string", Mask for Group Address

                    
"group-address": "string", IP group address

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"source-address": "string", IP source address

                    
"group-address-mask": "string", Mask for Group Address

                    
"source-address-mask": "string", Mask for Source Address

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"group-address": "string", IP group address

                    
"source-address": "string", IP source address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"source-address": "string", IP source address

                    
"group-address-mask": "string", Mask for Group Address

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"source-address": "string", IP source address

                    
"source-address-mask": "string", Mask for Source Address

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ]
              },
              
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
              : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
                
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

                
"access-list-name": "string" Access-list to account for

              },
              
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
              : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
                
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

                
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

                
"access-list-name": "string" Access-list to account for

              },
              
"version": "integer", Version number
range: "1..3"
default: "3"

              
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

              
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/

Create operation of resource: vrfs

vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : {
VRF related configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Inheritable DefaultsPUTPOSTDELETEGET
          
"access-group": "string", Access list specifying access group range
          : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
            
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

            
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

            
"access-list-name": "string" Access-list to account for

          },
          : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
            
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

            
"access-list-name": "string" Access-list to account for

          },
          
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

          
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

          
"version": "integer", Version number
range: "1..3"
default: "3"

          
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

          
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

        },
        : {
IGMP Source specific modePUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"access-list-name": "string", Access-list to account for

              
"source-address": "string" IP source address

            }
          ]
        },
        
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

        
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
        : {
Configure IGMP State LimitsPUTPOSTDELETEGET
          
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        },
        
"vrf-name": "string", Name for this vrf
        : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
          
"profile": "string" Configure the route-policy profile

        },
        : {
Interface-level configurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"access-group": "string", Access list specifying access group range

              
"interface-name": "string", Name of the interface
              : {
IGMP join multicast groupPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"group-address": "string", IP group address

                    
"mode": "string" Filter mode

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-address": "string", IP group address

                    
"mode": "string", Filter mode

                    
"source-address": "string" IP source address

                  }
                ]
              },
              : {
IGMP static multicast groupPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"group-address-mask": "string", Mask for Group Address

                    
"group-address": "string", IP group address

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"source-address": "string", IP source address

                    
"group-address-mask": "string", Mask for Group Address

                    
"source-address-mask": "string", Mask for Source Address

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"group-address": "string", IP group address

                    
"source-address": "string", IP source address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"source-address": "string", IP source address

                    
"group-address-mask": "string", Mask for Group Address

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"source-address": "string", IP source address

                    
"source-address-mask": "string", Mask for Source Address

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ]
              },
              
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
              : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
                
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

                
"access-list-name": "string" Access-list to account for

              },
              
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
              : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
                
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

                
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

                
"access-list-name": "string" Access-list to account for

              },
              
"version": "integer", Version number
range: "1..3"
default: "3"

              
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

              
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/

Delete operation of resource: vrfs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/

Retrieve operation of resource: vrfs

200 OK
vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
VRF related configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Inheritable DefaultsPUTPOSTDELETEGET
          
"access-group": "string", Access list specifying access group range
          : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
            
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

            
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

            
"access-list-name": "string" Access-list to account for

          },
          : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
            
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

            
"access-list-name": "string" Access-list to account for

          },
          
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

          
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

          
"version": "integer", Version number
range: "1..3"
default: "3"

          
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

          
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

        },
        : {
IGMP Source specific modePUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"access-list-name": "string", Access-list to account for

              
"source-address": "string" IP source address

            }
          ]
        },
        
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

        
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
        : {
Configure IGMP State LimitsPUTPOSTDELETEGET
          
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        },
        
"vrf-name": "string", Name for this vrf
        : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
          
"profile": "string" Configure the route-policy profile

        },
        : {
Interface-level configurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"access-group": "string", Access list specifying access group range

              
"interface-name": "string", Name of the interface
              : {
IGMP join multicast groupPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"group-address": "string", IP group address

                    
"mode": "string" Filter mode

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-address": "string", IP group address

                    
"mode": "string", Filter mode

                    
"source-address": "string" IP source address

                  }
                ]
              },
              : {
IGMP static multicast groupPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"group-address-mask": "string", Mask for Group Address

                    
"group-address": "string", IP group address

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"source-address": "string", IP source address

                    
"group-address-mask": "string", Mask for Group Address

                    
"source-address-mask": "string", Mask for Source Address

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"group-address": "string", IP group address

                    
"source-address": "string", IP source address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"source-address": "string", IP source address

                    
"group-address-mask": "string", Mask for Group Address

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"source-address": "string", IP source address

                    
"source-address-mask": "string", Mask for Source Address

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ]
              },
              
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
              : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
                
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

                
"access-list-name": "string" Access-list to account for

              },
              
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
              : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
                
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

                
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

                
"access-list-name": "string" Access-list to account for

              },
              
"version": "integer", Version number
range: "1..3"
default: "3"

              
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

              
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

            }
          ]
        }
      }
    ]
  }
}

VRF - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/

Update operation of resource: vrf

vrf_schema

vrfbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Inheritable DefaultsPUTPOSTDELETEGET
        
"access-group": "string", Access list specifying access group range
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      },
      : {
IGMP Source specific modePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-list-name": "string", Access-list to account for

            
"source-address": "string" IP source address

          }
        ]
      },
      
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

      
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
      : {
Configure IGMP State LimitsPUTPOSTDELETEGET
        
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      },
      
"vrf-name": "string", Name for this vrf
      : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
        
"profile": "string" Configure the route-policy profile

      },
      : {
Interface-level configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-group": "string", Access list specifying access group range

            
"interface-name": "string", Name of the interface
            : {
IGMP join multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string" Filter mode

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string", Filter mode

                  
"source-address": "string" IP source address

                }
              ]
            },
            : {
IGMP static multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"source-address": "string", IP source address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ]
            },
            
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
            : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
              
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

              
"access-list-name": "string" Access-list to account for

            },
            
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
            : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
              
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

              
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

              
"access-list-name": "string" Access-list to account for

            },
            
"version": "integer", Version number
range: "1..3"
default: "3"

            
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

            
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/

Create operation of resource: vrf

vrf_schema

vrfbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Inheritable DefaultsPUTPOSTDELETEGET
        
"access-group": "string", Access list specifying access group range
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      },
      : {
IGMP Source specific modePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-list-name": "string", Access-list to account for

            
"source-address": "string" IP source address

          }
        ]
      },
      
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

      
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
      : {
Configure IGMP State LimitsPUTPOSTDELETEGET
        
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      },
      
"vrf-name": "string", Name for this vrf
      : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
        
"profile": "string" Configure the route-policy profile

      },
      : {
Interface-level configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-group": "string", Access list specifying access group range

            
"interface-name": "string", Name of the interface
            : {
IGMP join multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string" Filter mode

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string", Filter mode

                  
"source-address": "string" IP source address

                }
              ]
            },
            : {
IGMP static multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"source-address": "string", IP source address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ]
            },
            
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
            : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
              
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

              
"access-list-name": "string" Access-list to account for

            },
            
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
            : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
              
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

              
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

              
"access-list-name": "string" Access-list to account for

            },
            
"version": "integer", Version number
range: "1..3"
default: "3"

            
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

            
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/

Delete operation of resource: vrf

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/

Retrieve operation of resource: vrf

vrf-name: string
in path

ID of vrf-name

200 OK
vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Inheritable DefaultsPUTPOSTDELETEGET
        
"access-group": "string", Access list specifying access group range
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      },
      : {
IGMP Source specific modePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-list-name": "string", Access-list to account for

            
"source-address": "string" IP source address

          }
        ]
      },
      
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

      
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
      : {
Configure IGMP State LimitsPUTPOSTDELETEGET
        
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      },
      
"vrf-name": "string", Name for this vrf
      : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
        
"profile": "string" Configure the route-policy profile

      },
      : {
Interface-level configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-group": "string", Access list specifying access group range

            
"interface-name": "string", Name of the interface
            : {
IGMP join multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string" Filter mode

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string", Filter mode

                  
"source-address": "string" IP source address

                }
              ]
            },
            : {
IGMP static multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"source-address": "string", IP source address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ]
            },
            
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
            : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
              
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

              
"access-list-name": "string" Access-list to account for

            },
            
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
            : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
              
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

              
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

              
"access-list-name": "string" Access-list to account for

            },
            
"version": "integer", Version number
range: "1..3"
default: "3"

            
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

            
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

          }
        ]
      }
    }
  ]
}

TRAFFIC - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/traffic/

Update operation of resource: traffic

traffic_schema

trafficbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
    
"profile": "string" Configure the route-policy profile

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/traffic/

Create operation of resource: traffic

traffic_schema

trafficbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
    
"profile": "string" Configure the route-policy profile

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/traffic/

Delete operation of resource: traffic

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/traffic/

Retrieve operation of resource: traffic

vrf-name: string
in path

ID of vrf-name

200 OK
traffic_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
    
"profile": "string" Configure the route-policy profile

  }
}

INHERITABLE-DEFAULTS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/inheritable-defaults/

Update operation of resource: inheritable-defaults

inheritable-defaults_schema

inheritable-defaultsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Inheritable DefaultsPUTPOSTDELETEGET
    
"access-group": "string", Access list specifying access group range
    : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
      
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

      
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      
"access-list-name": "string" Access list specifying tracking group range

    },
    : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
      
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

      
"access-list-name": "string" Access list specifying tracking group range

    },
    
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

    
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

    
"version": "integer", Version number
range: "1..3"
default: "3"

    
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

    
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/inheritable-defaults/

Create operation of resource: inheritable-defaults

inheritable-defaults_schema

inheritable-defaultsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Inheritable DefaultsPUTPOSTDELETEGET
    
"access-group": "string", Access list specifying access group range
    : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
      
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

      
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      
"access-list-name": "string" Access list specifying tracking group range

    },
    : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
      
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

      
"access-list-name": "string" Access list specifying tracking group range

    },
    
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

    
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

    
"version": "integer", Version number
range: "1..3"
default: "3"

    
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

    
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/inheritable-defaults/

Delete operation of resource: inheritable-defaults

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/inheritable-defaults/

Retrieve operation of resource: inheritable-defaults

vrf-name: string
in path

ID of vrf-name

200 OK
inheritable-defaults_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Inheritable DefaultsPUTPOSTDELETEGET
    
"access-group": "string", Access list specifying access group range
    : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
      
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

      
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      
"access-list-name": "string" Access list specifying tracking group range

    },
    : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
      
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

      
"access-list-name": "string" Access list specifying tracking group range

    },
    
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

    
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

    
"version": "integer", Version number
range: "1..3"
default: "3"

    
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

    
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

  }
}

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/inheritable-defaults/maximum-groups-per-interface-oor/

Update operation of resource: maximum-groups-per-interface-oor

maximum-groups-per-interface-oor_schema

maximum-groups-per-interface-oorbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/inheritable-defaults/maximum-groups-per-interface-oor/

Create operation of resource: maximum-groups-per-interface-oor

maximum-groups-per-interface-oor_schema

maximum-groups-per-interface-oorbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/inheritable-defaults/maximum-groups-per-interface-oor/

Delete operation of resource: maximum-groups-per-interface-oor

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/inheritable-defaults/maximum-groups-per-interface-oor/

Retrieve operation of resource: maximum-groups-per-interface-oor

vrf-name: string
in path

ID of vrf-name

200 OK
maximum-groups-per-interface-oor_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}

EXPLICIT-TRACKING - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/inheritable-defaults/explicit-tracking/

Update operation of resource: explicit-tracking

explicit-tracking_schema

explicit-trackingbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/inheritable-defaults/explicit-tracking/

Create operation of resource: explicit-tracking

explicit-tracking_schema

explicit-trackingbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/inheritable-defaults/explicit-tracking/

Delete operation of resource: explicit-tracking

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/inheritable-defaults/explicit-tracking/

Retrieve operation of resource: explicit-tracking

vrf-name: string
in path

ID of vrf-name

200 OK
explicit-tracking_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}

SSM-ACCESS-GROUPS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/ssm-access-groups/

Update operation of resource: ssm-access-groups

ssm-access-groups_schema

ssm-access-groupsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP Source specific modePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-list-name": "string", Access list specifying access group

        
"source-address": "string" IP source address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUPS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/ssm-access-groups/

Create operation of resource: ssm-access-groups

ssm-access-groups_schema

ssm-access-groupsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP Source specific modePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-list-name": "string", Access list specifying access group

        
"source-address": "string" IP source address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUPS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/ssm-access-groups/

Delete operation of resource: ssm-access-groups

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUPS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/ssm-access-groups/

Retrieve operation of resource: ssm-access-groups

vrf-name: string
in path

ID of vrf-name

200 OK
ssm-access-groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMP Source specific modePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-list-name": "string", Access list specifying access group

        
"source-address": "string" IP source address

      }
    ]
  }
}

SSM-ACCESS-GROUP - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/ssm-access-groups/ssm-access-group/{source-address}/

Update operation of resource: ssm-access-group

ssm-access-group_schema

ssm-access-groupbody object

vrf-name: string
in path

ID of vrf-name

source-address: string
in path

ID of source-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-list-name": "string", Access list specifying access group

      
"source-address": "string" IP source address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUP - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/ssm-access-groups/ssm-access-group/{source-address}/

Create operation of resource: ssm-access-group

ssm-access-group_schema

ssm-access-groupbody object

vrf-name: string
in path

ID of vrf-name

source-address: string
in path

ID of source-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-list-name": "string", Access list specifying access group

      
"source-address": "string" IP source address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUP - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/ssm-access-groups/ssm-access-group/{source-address}/

Delete operation of resource: ssm-access-group

vrf-name: string
in path

ID of vrf-name

source-address: string
in path

ID of source-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUP - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/ssm-access-groups/ssm-access-group/{source-address}/

Retrieve operation of resource: ssm-access-group

vrf-name: string
in path

ID of vrf-name

source-address: string
in path

ID of source-address

200 OK
ssm-access-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-list-name": "string", Access list specifying access group

      
"source-address": "string" IP source address

    }
  ]
}

MAXIMUM - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/maximum/

Update operation of resource: maximum

maximum_schema

maximumbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP State LimitsPUTPOSTDELETEGET
    
"maximum-groups": "integer" Configure maximum number of groups accepted by\nthis router
range: "1..40000"
default: "50000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/maximum/

Create operation of resource: maximum

maximum_schema

maximumbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP State LimitsPUTPOSTDELETEGET
    
"maximum-groups": "integer" Configure maximum number of groups accepted by\nthis router
range: "1..40000"
default: "50000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/maximum/

Delete operation of resource: maximum

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/maximum/

Retrieve operation of resource: maximum

vrf-name: string
in path

ID of vrf-name

200 OK
maximum_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IGMP State LimitsPUTPOSTDELETEGET
    
"maximum-groups": "integer" Configure maximum number of groups accepted by\nthis router
range: "1..40000"
default: "50000"

  }
}

INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/

Update operation of resource: interfaces

interfaces_schema

interfacesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Interface-level configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-group": "string", Access list specifying access group range

        
"interface-name": "string", Name of the interface
        : {
IGMP join multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string" Filter mode

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string", Filter mode

              
"source-address": "string" IP source address

            }
          ]
        },
        : {
IGMP static multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"source-address": "string", IP source address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ]
        },
        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/

Create operation of resource: interfaces

interfaces_schema

interfacesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Interface-level configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-group": "string", Access list specifying access group range

        
"interface-name": "string", Name of the interface
        : {
IGMP join multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string" Filter mode

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string", Filter mode

              
"source-address": "string" IP source address

            }
          ]
        },
        : {
IGMP static multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"source-address": "string", IP source address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ]
        },
        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/

Delete operation of resource: interfaces

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/

Retrieve operation of resource: interfaces

vrf-name: string
in path

ID of vrf-name

200 OK
interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Interface-level configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-group": "string", Access list specifying access group range

        
"interface-name": "string", Name of the interface
        : {
IGMP join multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string" Filter mode

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string", Filter mode

              
"source-address": "string" IP source address

            }
          ]
        },
        : {
IGMP static multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"source-address": "string", IP source address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ]
        },
        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      }
    ]
  }
}

INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/

Update operation of resource: interface

interface_schema

interfacebody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-group": "string", Access list specifying access group range

      
"interface-name": "string", Name of the interface
      : {
IGMP join multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string" Filter mode

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string", Filter mode

            
"source-address": "string" IP source address

          }
        ]
      },
      : {
IGMP static multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"source-address": "string", IP source address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ]
      },
      
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
      : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
        
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

        
"access-list-name": "string" Access-list to account for

      },
      
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
      : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
        
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

        
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        
"access-list-name": "string" Access-list to account for

      },
      
"version": "integer", Version number
range: "1..3"
default: "3"

      
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

      
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/

Create operation of resource: interface

interface_schema

interfacebody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-group": "string", Access list specifying access group range

      
"interface-name": "string", Name of the interface
      : {
IGMP join multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string" Filter mode

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string", Filter mode

            
"source-address": "string" IP source address

          }
        ]
      },
      : {
IGMP static multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"source-address": "string", IP source address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ]
      },
      
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
      : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
        
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

        
"access-list-name": "string" Access-list to account for

      },
      
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
      : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
        
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

        
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        
"access-list-name": "string" Access-list to account for

      },
      
"version": "integer", Version number
range: "1..3"
default: "3"

      
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

      
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/

Delete operation of resource: interface

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/

Retrieve operation of resource: interface

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK
interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-group": "string", Access list specifying access group range

      
"interface-name": "string", Name of the interface
      : {
IGMP join multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string" Filter mode

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string", Filter mode

            
"source-address": "string" IP source address

          }
        ]
      },
      : {
IGMP static multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"source-address": "string", IP source address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ]
      },
      
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
      : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
        
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

        
"access-list-name": "string" Access-list to account for

      },
      
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
      : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
        
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

        
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        
"access-list-name": "string" Access-list to account for

      },
      
"version": "integer", Version number
range: "1..3"
default: "3"

      
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

      
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

    }
  ]
}

JOIN-GROUPS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/

Update operation of resource: join-groups

join-groups_schema

join-groupsbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP join multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string" Filter mode

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string", Filter mode

        
"source-address": "string" Optional IP source address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUPS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/

Create operation of resource: join-groups

join-groups_schema

join-groupsbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP join multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string" Filter mode

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string", Filter mode

        
"source-address": "string" Optional IP source address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUPS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/

Delete operation of resource: join-groups

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUPS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/

Retrieve operation of resource: join-groups

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK
join-groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMP join multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string" Filter mode

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string", Filter mode

        
"source-address": "string" Optional IP source address

      }
    ]
  }
}

JOIN-GROUP - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/join-group/{group-address}/

Update operation of resource: join-group

join-group_schema

join-groupbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string" Filter mode

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string", Filter mode

      
"source-address": "string" Optional IP source address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/join-group/{group-address}/

Create operation of resource: join-group

join-group_schema

join-groupbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string" Filter mode

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string", Filter mode

      
"source-address": "string" Optional IP source address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/join-group/{group-address}/

Delete operation of resource: join-group

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/join-group/{group-address}/

Retrieve operation of resource: join-group

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

200 OK
join-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string" Filter mode

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string", Filter mode

      
"source-address": "string" Optional IP source address

    }
  ]
}

JOIN-GROUP-SOURCE-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/join-group-source-address/{group-address source-address}/

Update operation of resource: join-group-source-address

join-group-source-address_schema

join-group-source-addressbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-address": "string", IP group address

    
"mode": "string", Filter mode

    
"source-address": "string" Optional IP source address

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP-SOURCE-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/join-group-source-address/{group-address source-address}/

Create operation of resource: join-group-source-address

join-group-source-address_schema

join-group-source-addressbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-address": "string", IP group address

    
"mode": "string", Filter mode

    
"source-address": "string" Optional IP source address

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP-SOURCE-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/join-group-source-address/{group-address source-address}/

Delete operation of resource: join-group-source-address

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP-SOURCE-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/join-group-source-address/{group-address source-address}/

Retrieve operation of resource: join-group-source-address

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

200 OK
join-group-source-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-address": "string", IP group address

    
"mode": "string", Filter mode

    
"source-address": "string" Optional IP source address

  }
}

STATIC-GROUP-GROUP-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/

Update operation of resource: static-group-group-addresses

static-group-group-addresses_schema

static-group-group-addressesbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP static multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"source-address": "string", IP source address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/

Create operation of resource: static-group-group-addresses

static-group-group-addresses_schema

static-group-group-addressesbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP static multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"source-address": "string", IP source address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/

Delete operation of resource: static-group-group-addresses

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/

Retrieve operation of resource: static-group-group-addresses

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK
static-group-group-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMP static multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"source-address": "string", IP source address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ]
  }
}

STATIC-GROUP-GROUP-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address/{group-address}/

Update operation of resource: static-group-group-address

static-group-group-address_schema

static-group-group-addressbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"source-address": "string", IP source address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address/{group-address}/

Create operation of resource: static-group-group-address

static-group-group-address_schema

static-group-group-addressbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"source-address": "string", IP source address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address/{group-address}/

Delete operation of resource: static-group-group-address

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address/{group-address}/

Retrieve operation of resource: static-group-group-address

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

200 OK
static-group-group-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"source-address": "string", IP source address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ]
}

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address/{group-address source-address}/

Update operation of resource: static-group-group-address-source-address

static-group-group-address-source-address_schema

static-group-group-address-source-addressbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"group-address": "string", IP group address

    
"source-address": "string", IP source address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address/{group-address source-address}/

Create operation of resource: static-group-group-address-source-address

static-group-group-address-source-address_schema

static-group-group-address-source-addressbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"group-address": "string", IP group address

    
"source-address": "string", IP source address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address/{group-address source-address}/

Delete operation of resource: static-group-group-address-source-address

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address/{group-address source-address}/

Retrieve operation of resource: static-group-group-address-source-address

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

200 OK
static-group-group-address-source-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"group-address": "string", IP group address

    
"source-address": "string", IP source address

    
"suppress-report": "boolean" Suppress reports

  }
}

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address-source-address-mask/{group-address source-address source-address-mask}/

Update operation of resource: static-group-group-address-source-address-source-address-mask

static-group-group-address-source-address-source-address-mask_schema

static-group-group-address-source-address-source-address-maskbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address source-address-mask: string
in path

ID of group-address source-address source-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address-source-address-mask/{group-address source-address source-address-mask}/

Create operation of resource: static-group-group-address-source-address-source-address-mask

static-group-group-address-source-address-source-address-mask_schema

static-group-group-address-source-address-source-address-maskbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address source-address-mask: string
in path

ID of group-address source-address source-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address-source-address-mask/{group-address source-address source-address-mask}/

Delete operation of resource: static-group-group-address-source-address-source-address-mask

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address source-address-mask: string
in path

ID of group-address source-address source-address-mask

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address-source-address-mask/{group-address source-address source-address-mask}/

Retrieve operation of resource: static-group-group-address-source-address-source-address-mask

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address source-address-mask: string
in path

ID of group-address source-address source-address-mask

200 OK
static-group-group-address-source-address-source-address-mask_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask/{group-address group-address-mask}/

Update operation of resource: static-group-group-address-group-address-mask

static-group-group-address-group-address-mask_schema

static-group-group-address-group-address-maskbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask: string
in path

ID of group-address group-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask/{group-address group-address-mask}/

Create operation of resource: static-group-group-address-group-address-mask

static-group-group-address-group-address-mask_schema

static-group-group-address-group-address-maskbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask: string
in path

ID of group-address group-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask/{group-address group-address-mask}/

Delete operation of resource: static-group-group-address-group-address-mask

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask: string
in path

ID of group-address group-address-mask

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask/{group-address group-address-mask}/

Retrieve operation of resource: static-group-group-address-group-address-mask

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask: string
in path

ID of group-address group-address-mask

200 OK
static-group-group-address-group-address-mask_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"suppress-report": "boolean" Suppress reports

  }
}

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address/{group-address group-address-mask source-address}/

Update operation of resource: static-group-group-address-group-address-mask-source-address

static-group-group-address-group-address-mask-source-address_schema

static-group-group-address-group-address-mask-source-addressbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address: string
in path

ID of group-address group-address-mask source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address/{group-address group-address-mask source-address}/

Create operation of resource: static-group-group-address-group-address-mask-source-address

static-group-group-address-group-address-mask-source-address_schema

static-group-group-address-group-address-mask-source-addressbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address: string
in path

ID of group-address group-address-mask source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address/{group-address group-address-mask source-address}/

Delete operation of resource: static-group-group-address-group-address-mask-source-address

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address: string
in path

ID of group-address group-address-mask source-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address/{group-address group-address-mask source-address}/

Retrieve operation of resource: static-group-group-address-group-address-mask-source-address

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address: string
in path

ID of group-address group-address-mask source-address

200 OK
static-group-group-address-group-address-mask-source-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address-source-address-mask/{group-address group-address-mask source-address source-address-mask}/

Update operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask

static-group-group-address-group-address-mask-source-address-source-address-mask_schema

static-group-group-address-group-address-mask-source-address-source-address-maskbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address source-address-mask: string
in path

ID of group-address group-address-mask source-address source-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address-source-address-mask/{group-address group-address-mask source-address source-address-mask}/

Create operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask

static-group-group-address-group-address-mask-source-address-source-address-mask_schema

static-group-group-address-group-address-mask-source-address-source-address-maskbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address source-address-mask: string
in path

ID of group-address group-address-mask source-address source-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address-source-address-mask/{group-address group-address-mask source-address source-address-mask}/

Delete operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address source-address-mask: string
in path

ID of group-address group-address-mask source-address source-address-mask

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address-source-address-mask/{group-address group-address-mask source-address source-address-mask}/

Retrieve operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address source-address-mask: string
in path

ID of group-address group-address-mask source-address source-address-mask

200 OK
static-group-group-address-group-address-mask-source-address-source-address-mask_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/maximum-groups-per-interface-oor/

Update operation of resource: maximum-groups-per-interface-oor

maximum-groups-per-interface-oor_schema

maximum-groups-per-interface-oorbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/maximum-groups-per-interface-oor/

Create operation of resource: maximum-groups-per-interface-oor

maximum-groups-per-interface-oor_schema

maximum-groups-per-interface-oorbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/maximum-groups-per-interface-oor/

Delete operation of resource: maximum-groups-per-interface-oor

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/maximum-groups-per-interface-oor/

Retrieve operation of resource: maximum-groups-per-interface-oor

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK
maximum-groups-per-interface-oor_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}

EXPLICIT-TRACKING - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/explicit-tracking/

Update operation of resource: explicit-tracking

explicit-tracking_schema

explicit-trackingbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/explicit-tracking/

Create operation of resource: explicit-tracking

explicit-tracking_schema

explicit-trackingbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/explicit-tracking/

Delete operation of resource: explicit-tracking

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/explicit-tracking/

Retrieve operation of resource: explicit-tracking

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK
explicit-tracking_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}

DEFAULT-CONTEXT - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/

Update operation of resource: default-context

default-context_schema

default-contextbody object

Request Content-Types: application/json
Request Example
{
  : {
Default ContextPUTPOSTDELETEGET
    : {
Inheritable DefaultsPUTPOSTDELETEGET
      
"access-group": "string", Access list specifying access group range
      : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
        
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

        
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        
"access-list-name": "string" Access-list to account for

      },
      : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
        
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

        
"access-list-name": "string" Access-list to account for

      },
      
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

      
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

      
"version": "integer", Version number
range: "1..3"
default: "3"

      
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

      
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

    },
    : {
Configure IGMP QoS shapers for subscriber\ninterfacesPUTPOSTDELETEGET
      
"download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"

      
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"

      
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"

    },
    : {
IGMP Source specific modePUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"access-list-name": "string", Access-list to account for

          
"source-address": "string" IP source address

        }
      ]
    },
    
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

    
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
    : {
Configure IGMP State LimitsPUTPOSTDELETEGET
      
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    },
    : {
Configure NSF specific optionsPUTPOSTDELETEGET
      
"lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"

    },
    : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
      
"profile": "string" Configure the route-policy profile

    },
    : {
Configure IGMP accounting for logging\njoin/leave recordsPUTPOSTDELETEGET
      
"max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"

    },
    : {
Interface-level configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"access-group": "string", Access list specifying access group range

          
"interface-name": "string", Name of the interface
          : {
IGMP join multicast groupPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-address": "string", IP group address

                
"mode": "string" Filter mode

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-address": "string", IP group address

                
"mode": "string", Filter mode

                
"source-address": "string" IP source address

              }
            ]
          },
          : {
IGMP static multicast groupPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"group-address-mask": "string", Mask for Group Address

                
"group-address": "string", IP group address

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"source-address": "string", IP source address

                
"group-address-mask": "string", Mask for Group Address

                
"source-address-mask": "string", Mask for Source Address

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"group-address": "string", IP group address

                
"source-address": "string", IP source address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"source-address": "string", IP source address

                
"group-address-mask": "string", Mask for Group Address

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"source-address": "string", IP source address

                
"source-address-mask": "string", Mask for Source Address

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ]
          },
          
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
          : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
            
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

            
"access-list-name": "string" Access-list to account for

          },
          
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
          : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
            
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

            
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

            
"access-list-name": "string" Access-list to account for

          },
          
"version": "integer", Version number
range: "1..3"
default: "3"

          
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

          
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-CONTEXT - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/

Create operation of resource: default-context

default-context_schema

default-contextbody object

Request Content-Types: application/json
Request Example
{
  : {
Default ContextPUTPOSTDELETEGET
    : {
Inheritable DefaultsPUTPOSTDELETEGET
      
"access-group": "string", Access list specifying access group range
      : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
        
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

        
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        
"access-list-name": "string" Access-list to account for

      },
      : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
        
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

        
"access-list-name": "string" Access-list to account for

      },
      
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

      
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

      
"version": "integer", Version number
range: "1..3"
default: "3"

      
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

      
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

    },
    : {
Configure IGMP QoS shapers for subscriber\ninterfacesPUTPOSTDELETEGET
      
"download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"

      
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"

      
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"

    },
    : {
IGMP Source specific modePUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"access-list-name": "string", Access-list to account for

          
"source-address": "string" IP source address

        }
      ]
    },
    
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

    
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
    : {
Configure IGMP State LimitsPUTPOSTDELETEGET
      
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    },
    : {
Configure NSF specific optionsPUTPOSTDELETEGET
      
"lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"

    },
    : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
      
"profile": "string" Configure the route-policy profile

    },
    : {
Configure IGMP accounting for logging\njoin/leave recordsPUTPOSTDELETEGET
      
"max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"

    },
    : {
Interface-level configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"access-group": "string", Access list specifying access group range

          
"interface-name": "string", Name of the interface
          : {
IGMP join multicast groupPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-address": "string", IP group address

                
"mode": "string" Filter mode

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-address": "string", IP group address

                
"mode": "string", Filter mode

                
"source-address": "string" IP source address

              }
            ]
          },
          : {
IGMP static multicast groupPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"group-address-mask": "string", Mask for Group Address

                
"group-address": "string", IP group address

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"source-address": "string", IP source address

                
"group-address-mask": "string", Mask for Group Address

                
"source-address-mask": "string", Mask for Source Address

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"group-address": "string", IP group address

                
"source-address": "string", IP source address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"source-address": "string", IP source address

                
"group-address-mask": "string", Mask for Group Address

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"source-address": "string", IP source address

                
"source-address-mask": "string", Mask for Source Address

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ]
          },
          
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
          : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
            
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

            
"access-list-name": "string" Access-list to account for

          },
          
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
          : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
            
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

            
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

            
"access-list-name": "string" Access-list to account for

          },
          
"version": "integer", Version number
range: "1..3"
default: "3"

          
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

          
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-CONTEXT - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/

Delete operation of resource: default-context

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-CONTEXT - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/

Retrieve operation of resource: default-context

200 OK
default-context_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Default ContextPUTPOSTDELETEGET
    : {
Inheritable DefaultsPUTPOSTDELETEGET
      
"access-group": "string", Access list specifying access group range
      : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
        
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

        
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        
"access-list-name": "string" Access-list to account for

      },
      : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
        
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

        
"access-list-name": "string" Access-list to account for

      },
      
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

      
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

      
"version": "integer", Version number
range: "1..3"
default: "3"

      
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

      
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

    },
    : {
Configure IGMP QoS shapers for subscriber\ninterfacesPUTPOSTDELETEGET
      
"download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"

      
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"

      
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"

    },
    : {
IGMP Source specific modePUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"access-list-name": "string", Access-list to account for

          
"source-address": "string" IP source address

        }
      ]
    },
    
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

    
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
    : {
Configure IGMP State LimitsPUTPOSTDELETEGET
      
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    },
    : {
Configure NSF specific optionsPUTPOSTDELETEGET
      
"lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"

    },
    : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
      
"profile": "string" Configure the route-policy profile

    },
    : {
Configure IGMP accounting for logging\njoin/leave recordsPUTPOSTDELETEGET
      
"max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"

    },
    : {
Interface-level configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"access-group": "string", Access list specifying access group range

          
"interface-name": "string", Name of the interface
          : {
IGMP join multicast groupPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-address": "string", IP group address

                
"mode": "string" Filter mode

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-address": "string", IP group address

                
"mode": "string", Filter mode

                
"source-address": "string" IP source address

              }
            ]
          },
          : {
IGMP static multicast groupPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"group-address-mask": "string", Mask for Group Address

                
"group-address": "string", IP group address

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"source-address": "string", IP source address

                
"group-address-mask": "string", Mask for Group Address

                
"source-address-mask": "string", Mask for Source Address

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"group-address": "string", IP group address

                
"source-address": "string", IP source address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"source-address": "string", IP source address

                
"group-address-mask": "string", Mask for Group Address

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"source-address": "string", IP source address

                
"source-address-mask": "string", Mask for Source Address

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ]
          },
          
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
          : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
            
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

            
"access-list-name": "string" Access-list to account for

          },
          
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
          : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
            
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

            
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

            
"access-list-name": "string" Access-list to account for

          },
          
"version": "integer", Version number
range: "1..3"
default: "3"

          
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

          
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

        }
      ]
    }
  }
}

NSF - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/nsf/

Update operation of resource: nsf

nsf_schema

nsfbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure NSF specific optionsPUTPOSTDELETEGET
    
"lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NSF - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/nsf/

Create operation of resource: nsf

nsf_schema

nsfbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure NSF specific optionsPUTPOSTDELETEGET
    
"lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NSF - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/nsf/

Delete operation of resource: nsf

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NSF - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/nsf/

Retrieve operation of resource: nsf

200 OK
nsf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure NSF specific optionsPUTPOSTDELETEGET
    
"lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"

  }
}

UNICAST-QOS-ADJUST - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/unicast-qos-adjust/

Update operation of resource: unicast-qos-adjust

unicast-qos-adjust_schema

unicast-qos-adjustbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP QoS shapers for subscriber\ninterfacesPUTPOSTDELETEGET
    
"download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"

    
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"

    
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UNICAST-QOS-ADJUST - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/unicast-qos-adjust/

Create operation of resource: unicast-qos-adjust

unicast-qos-adjust_schema

unicast-qos-adjustbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP QoS shapers for subscriber\ninterfacesPUTPOSTDELETEGET
    
"download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"

    
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"

    
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UNICAST-QOS-ADJUST - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/unicast-qos-adjust/

Delete operation of resource: unicast-qos-adjust

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UNICAST-QOS-ADJUST - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/unicast-qos-adjust/

Retrieve operation of resource: unicast-qos-adjust

200 OK
unicast-qos-adjust_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IGMP QoS shapers for subscriber\ninterfacesPUTPOSTDELETEGET
    
"download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"

    
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"

    
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"

  }
}

ACCOUNTING - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/accounting/

Update operation of resource: accounting

accounting_schema

accountingbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP accounting for logging\njoin/leave recordsPUTPOSTDELETEGET
    
"max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCOUNTING - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/accounting/

Create operation of resource: accounting

accounting_schema

accountingbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP accounting for logging\njoin/leave recordsPUTPOSTDELETEGET
    
"max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCOUNTING - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/accounting/

Delete operation of resource: accounting

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCOUNTING - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/accounting/

Retrieve operation of resource: accounting

200 OK
accounting_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IGMP accounting for logging\njoin/leave recordsPUTPOSTDELETEGET
    
"max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"

  }
}

TRAFFIC - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/traffic/

Update operation of resource: traffic

traffic_schema

trafficbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
    
"profile": "string" Configure the route-policy profile

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/traffic/

Create operation of resource: traffic

traffic_schema

trafficbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
    
"profile": "string" Configure the route-policy profile

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/traffic/

Delete operation of resource: traffic

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/traffic/

Retrieve operation of resource: traffic

200 OK
traffic_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
    
"profile": "string" Configure the route-policy profile

  }
}

INHERITABLE-DEFAULTS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/inheritable-defaults/

Update operation of resource: inheritable-defaults

inheritable-defaults_schema

inheritable-defaultsbody object

Request Content-Types: application/json
Request Example
{
  : {
Inheritable DefaultsPUTPOSTDELETEGET
    
"access-group": "string", Access list specifying access group range
    : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
      
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

      
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      
"access-list-name": "string" Access list specifying tracking group range

    },
    : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
      
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

      
"access-list-name": "string" Access list specifying tracking group range

    },
    
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

    
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

    
"version": "integer", Version number
range: "1..3"
default: "3"

    
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

    
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/inheritable-defaults/

Create operation of resource: inheritable-defaults

inheritable-defaults_schema

inheritable-defaultsbody object

Request Content-Types: application/json
Request Example
{
  : {
Inheritable DefaultsPUTPOSTDELETEGET
    
"access-group": "string", Access list specifying access group range
    : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
      
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

      
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      
"access-list-name": "string" Access list specifying tracking group range

    },
    : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
      
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

      
"access-list-name": "string" Access list specifying tracking group range

    },
    
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

    
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

    
"version": "integer", Version number
range: "1..3"
default: "3"

    
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

    
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/inheritable-defaults/

Delete operation of resource: inheritable-defaults

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/inheritable-defaults/

Retrieve operation of resource: inheritable-defaults

200 OK
inheritable-defaults_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Inheritable DefaultsPUTPOSTDELETEGET
    
"access-group": "string", Access list specifying access group range
    : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
      
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

      
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      
"access-list-name": "string" Access list specifying tracking group range

    },
    : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
      
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

      
"access-list-name": "string" Access list specifying tracking group range

    },
    
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

    
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

    
"version": "integer", Version number
range: "1..3"
default: "3"

    
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

    
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

  }
}

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/inheritable-defaults/maximum-groups-per-interface-oor/

Update operation of resource: maximum-groups-per-interface-oor

maximum-groups-per-interface-oor_schema

maximum-groups-per-interface-oorbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/inheritable-defaults/maximum-groups-per-interface-oor/

Create operation of resource: maximum-groups-per-interface-oor

maximum-groups-per-interface-oor_schema

maximum-groups-per-interface-oorbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/inheritable-defaults/maximum-groups-per-interface-oor/

Delete operation of resource: maximum-groups-per-interface-oor

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/inheritable-defaults/maximum-groups-per-interface-oor/

Retrieve operation of resource: maximum-groups-per-interface-oor

200 OK
maximum-groups-per-interface-oor_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}

EXPLICIT-TRACKING - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/inheritable-defaults/explicit-tracking/

Update operation of resource: explicit-tracking

explicit-tracking_schema

explicit-trackingbody object

Request Content-Types: application/json
Request Example
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/inheritable-defaults/explicit-tracking/

Create operation of resource: explicit-tracking

explicit-tracking_schema

explicit-trackingbody object

Request Content-Types: application/json
Request Example
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/inheritable-defaults/explicit-tracking/

Delete operation of resource: explicit-tracking

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/inheritable-defaults/explicit-tracking/

Retrieve operation of resource: explicit-tracking

200 OK
explicit-tracking_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}

SSM-ACCESS-GROUPS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/ssm-access-groups/

Update operation of resource: ssm-access-groups

ssm-access-groups_schema

ssm-access-groupsbody object

Request Content-Types: application/json
Request Example
{
  : {
IGMP Source specific modePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-list-name": "string", Access list specifying access group

        
"source-address": "string" IP source address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUPS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/ssm-access-groups/

Create operation of resource: ssm-access-groups

ssm-access-groups_schema

ssm-access-groupsbody object

Request Content-Types: application/json
Request Example
{
  : {
IGMP Source specific modePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-list-name": "string", Access list specifying access group

        
"source-address": "string" IP source address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUPS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/ssm-access-groups/

Delete operation of resource: ssm-access-groups

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUPS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/ssm-access-groups/

Retrieve operation of resource: ssm-access-groups

200 OK
ssm-access-groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMP Source specific modePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-list-name": "string", Access list specifying access group

        
"source-address": "string" IP source address

      }
    ]
  }
}

SSM-ACCESS-GROUP - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/ssm-access-groups/ssm-access-group/{source-address}/

Update operation of resource: ssm-access-group

ssm-access-group_schema

ssm-access-groupbody object

source-address: string
in path

ID of source-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-list-name": "string", Access list specifying access group

      
"source-address": "string" IP source address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUP - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/ssm-access-groups/ssm-access-group/{source-address}/

Create operation of resource: ssm-access-group

ssm-access-group_schema

ssm-access-groupbody object

source-address: string
in path

ID of source-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-list-name": "string", Access list specifying access group

      
"source-address": "string" IP source address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUP - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/ssm-access-groups/ssm-access-group/{source-address}/

Delete operation of resource: ssm-access-group

source-address: string
in path

ID of source-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUP - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/ssm-access-groups/ssm-access-group/{source-address}/

Retrieve operation of resource: ssm-access-group

source-address: string
in path

ID of source-address

200 OK
ssm-access-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-list-name": "string", Access list specifying access group

      
"source-address": "string" IP source address

    }
  ]
}

MAXIMUM - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/maximum/

Update operation of resource: maximum

maximum_schema

maximumbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP State LimitsPUTPOSTDELETEGET
    
"maximum-groups": "integer" Configure maximum number of groups accepted by\nthis router
range: "1..40000"
default: "50000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/maximum/

Create operation of resource: maximum

maximum_schema

maximumbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP State LimitsPUTPOSTDELETEGET
    
"maximum-groups": "integer" Configure maximum number of groups accepted by\nthis router
range: "1..40000"
default: "50000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/maximum/

Delete operation of resource: maximum

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/maximum/

Retrieve operation of resource: maximum

200 OK
maximum_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IGMP State LimitsPUTPOSTDELETEGET
    
"maximum-groups": "integer" Configure maximum number of groups accepted by\nthis router
range: "1..40000"
default: "50000"

  }
}

INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/

Update operation of resource: interfaces

interfaces_schema

interfacesbody object

Request Content-Types: application/json
Request Example
{
  : {
Interface-level configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-group": "string", Access list specifying access group range

        
"interface-name": "string", Name of the interface
        : {
IGMP join multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string" Filter mode

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string", Filter mode

              
"source-address": "string" IP source address

            }
          ]
        },
        : {
IGMP static multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"source-address": "string", IP source address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ]
        },
        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/

Create operation of resource: interfaces

interfaces_schema

interfacesbody object

Request Content-Types: application/json
Request Example
{
  : {
Interface-level configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-group": "string", Access list specifying access group range

        
"interface-name": "string", Name of the interface
        : {
IGMP join multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string" Filter mode

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string", Filter mode

              
"source-address": "string" IP source address

            }
          ]
        },
        : {
IGMP static multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"source-address": "string", IP source address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ]
        },
        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/

Delete operation of resource: interfaces

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/

Retrieve operation of resource: interfaces

200 OK
interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Interface-level configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-group": "string", Access list specifying access group range

        
"interface-name": "string", Name of the interface
        : {
IGMP join multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string" Filter mode

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string", Filter mode

              
"source-address": "string" IP source address

            }
          ]
        },
        : {
IGMP static multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"source-address": "string", IP source address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ]
        },
        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      }
    ]
  }
}

INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/

Update operation of resource: interface

interface_schema

interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-group": "string", Access list specifying access group range

      
"interface-name": "string", Name of the interface
      : {
IGMP join multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string" Filter mode

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string", Filter mode

            
"source-address": "string" IP source address

          }
        ]
      },
      : {
IGMP static multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"source-address": "string", IP source address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ]
      },
      
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
      : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
        
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

        
"access-list-name": "string" Access-list to account for

      },
      
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
      : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
        
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

        
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        
"access-list-name": "string" Access-list to account for

      },
      
"version": "integer", Version number
range: "1..3"
default: "3"

      
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

      
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/

Create operation of resource: interface

interface_schema

interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-group": "string", Access list specifying access group range

      
"interface-name": "string", Name of the interface
      : {
IGMP join multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string" Filter mode

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string", Filter mode

            
"source-address": "string" IP source address

          }
        ]
      },
      : {
IGMP static multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"source-address": "string", IP source address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ]
      },
      
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
      : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
        
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

        
"access-list-name": "string" Access-list to account for

      },
      
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
      : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
        
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

        
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        
"access-list-name": "string" Access-list to account for

      },
      
"version": "integer", Version number
range: "1..3"
default: "3"

      
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

      
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/

Delete operation of resource: interface

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/

Retrieve operation of resource: interface

interface-name: string
in path

ID of interface-name

200 OK
interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-group": "string", Access list specifying access group range

      
"interface-name": "string", Name of the interface
      : {
IGMP join multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string" Filter mode

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string", Filter mode

            
"source-address": "string" IP source address

          }
        ]
      },
      : {
IGMP static multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"source-address": "string", IP source address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ]
      },
      
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
      : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
        
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

        
"access-list-name": "string" Access-list to account for

      },
      
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
      : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
        
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

        
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        
"access-list-name": "string" Access-list to account for

      },
      
"version": "integer", Version number
range: "1..3"
default: "3"

      
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

      
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

    }
  ]
}

JOIN-GROUPS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/join-groups/

Update operation of resource: join-groups

join-groups_schema

join-groupsbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP join multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string" Filter mode

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string", Filter mode

        
"source-address": "string" Optional IP source address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUPS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/join-groups/

Create operation of resource: join-groups

join-groups_schema

join-groupsbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP join multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string" Filter mode

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string", Filter mode

        
"source-address": "string" Optional IP source address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUPS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/join-groups/

Delete operation of resource: join-groups

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUPS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/join-groups/

Retrieve operation of resource: join-groups

interface-name: string
in path

ID of interface-name

200 OK
join-groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMP join multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string" Filter mode

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string", Filter mode

        
"source-address": "string" Optional IP source address

      }
    ]
  }
}

JOIN-GROUP - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/join-groups/join-group/{group-address}/

Update operation of resource: join-group

join-group_schema

join-groupbody object

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string" Filter mode

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string", Filter mode

      
"source-address": "string" Optional IP source address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/join-groups/join-group/{group-address}/

Create operation of resource: join-group

join-group_schema

join-groupbody object

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string" Filter mode

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string", Filter mode

      
"source-address": "string" Optional IP source address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/join-groups/join-group/{group-address}/

Delete operation of resource: join-group

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/join-groups/join-group/{group-address}/

Retrieve operation of resource: join-group

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

200 OK
join-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string" Filter mode

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string", Filter mode

      
"source-address": "string" Optional IP source address

    }
  ]
}

JOIN-GROUP-SOURCE-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/join-groups/join-group-source-address/{group-address source-address}/

Update operation of resource: join-group-source-address

join-group-source-address_schema

join-group-source-addressbody object

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-address": "string", IP group address

    
"mode": "string", Filter mode

    
"source-address": "string" Optional IP source address

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP-SOURCE-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/join-groups/join-group-source-address/{group-address source-address}/

Create operation of resource: join-group-source-address

join-group-source-address_schema

join-group-source-addressbody object

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-address": "string", IP group address

    
"mode": "string", Filter mode

    
"source-address": "string" Optional IP source address

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP-SOURCE-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/join-groups/join-group-source-address/{group-address source-address}/

Delete operation of resource: join-group-source-address

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP-SOURCE-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/join-groups/join-group-source-address/{group-address source-address}/

Retrieve operation of resource: join-group-source-address

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

200 OK
join-group-source-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-address": "string", IP group address

    
"mode": "string", Filter mode

    
"source-address": "string" Optional IP source address

  }
}

STATIC-GROUP-GROUP-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/

Update operation of resource: static-group-group-addresses

static-group-group-addresses_schema

static-group-group-addressesbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP static multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"source-address": "string", IP source address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/

Create operation of resource: static-group-group-addresses

static-group-group-addresses_schema

static-group-group-addressesbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP static multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"source-address": "string", IP source address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/

Delete operation of resource: static-group-group-addresses

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/

Retrieve operation of resource: static-group-group-addresses

interface-name: string
in path

ID of interface-name

200 OK
static-group-group-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMP static multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"source-address": "string", IP source address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ]
  }
}

STATIC-GROUP-GROUP-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address/{group-address}/

Update operation of resource: static-group-group-address

static-group-group-address_schema

static-group-group-addressbody object

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"source-address": "string", IP source address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address/{group-address}/

Create operation of resource: static-group-group-address

static-group-group-address_schema

static-group-group-addressbody object

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"source-address": "string", IP source address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address/{group-address}/

Delete operation of resource: static-group-group-address

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address/{group-address}/

Retrieve operation of resource: static-group-group-address

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

200 OK
static-group-group-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"source-address": "string", IP source address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ]
}

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address/{group-address source-address}/

Update operation of resource: static-group-group-address-source-address

static-group-group-address-source-address_schema

static-group-group-address-source-addressbody object

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"group-address": "string", IP group address

    
"source-address": "string", IP source address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address/{group-address source-address}/

Create operation of resource: static-group-group-address-source-address

static-group-group-address-source-address_schema

static-group-group-address-source-addressbody object

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"group-address": "string", IP group address

    
"source-address": "string", IP source address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address/{group-address source-address}/

Delete operation of resource: static-group-group-address-source-address

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address/{group-address source-address}/

Retrieve operation of resource: static-group-group-address-source-address

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

200 OK
static-group-group-address-source-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"group-address": "string", IP group address

    
"source-address": "string", IP source address

    
"suppress-report": "boolean" Suppress reports

  }
}

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address-source-address-mask/{group-address source-address source-address-mask}/

Update operation of resource: static-group-group-address-source-address-source-address-mask

static-group-group-address-source-address-source-address-mask_schema

static-group-group-address-source-address-source-address-maskbody object

interface-name: string
in path

ID of interface-name

group-address source-address source-address-mask: string
in path

ID of group-address source-address source-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address-source-address-mask/{group-address source-address source-address-mask}/

Create operation of resource: static-group-group-address-source-address-source-address-mask

static-group-group-address-source-address-source-address-mask_schema

static-group-group-address-source-address-source-address-maskbody object

interface-name: string
in path

ID of interface-name

group-address source-address source-address-mask: string
in path

ID of group-address source-address source-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address-source-address-mask/{group-address source-address source-address-mask}/

Delete operation of resource: static-group-group-address-source-address-source-address-mask

interface-name: string
in path

ID of interface-name

group-address source-address source-address-mask: string
in path

ID of group-address source-address source-address-mask

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address-source-address-mask/{group-address source-address source-address-mask}/

Retrieve operation of resource: static-group-group-address-source-address-source-address-mask

interface-name: string
in path

ID of interface-name

group-address source-address source-address-mask: string
in path

ID of group-address source-address source-address-mask

200 OK
static-group-group-address-source-address-source-address-mask_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask/{group-address group-address-mask}/

Update operation of resource: static-group-group-address-group-address-mask

static-group-group-address-group-address-mask_schema

static-group-group-address-group-address-maskbody object

interface-name: string
in path

ID of interface-name

group-address group-address-mask: string
in path

ID of group-address group-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask/{group-address group-address-mask}/

Create operation of resource: static-group-group-address-group-address-mask

static-group-group-address-group-address-mask_schema

static-group-group-address-group-address-maskbody object

interface-name: string
in path

ID of interface-name

group-address group-address-mask: string
in path

ID of group-address group-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask/{group-address group-address-mask}/

Delete operation of resource: static-group-group-address-group-address-mask

interface-name: string
in path

ID of interface-name

group-address group-address-mask: string
in path

ID of group-address group-address-mask

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask/{group-address group-address-mask}/

Retrieve operation of resource: static-group-group-address-group-address-mask

interface-name: string
in path

ID of interface-name

group-address group-address-mask: string
in path

ID of group-address group-address-mask

200 OK
static-group-group-address-group-address-mask_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"suppress-report": "boolean" Suppress reports

  }
}

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address/{group-address group-address-mask source-address}/

Update operation of resource: static-group-group-address-group-address-mask-source-address

static-group-group-address-group-address-mask-source-address_schema

static-group-group-address-group-address-mask-source-addressbody object

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address: string
in path

ID of group-address group-address-mask source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address/{group-address group-address-mask source-address}/

Create operation of resource: static-group-group-address-group-address-mask-source-address

static-group-group-address-group-address-mask-source-address_schema

static-group-group-address-group-address-mask-source-addressbody object

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address: string
in path

ID of group-address group-address-mask source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address/{group-address group-address-mask source-address}/

Delete operation of resource: static-group-group-address-group-address-mask-source-address

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address: string
in path

ID of group-address group-address-mask source-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address/{group-address group-address-mask source-address}/

Retrieve operation of resource: static-group-group-address-group-address-mask-source-address

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address: string
in path

ID of group-address group-address-mask source-address

200 OK
static-group-group-address-group-address-mask-source-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address-source-address-mask/{group-address group-address-mask source-address source-address-mask}/

Update operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask

static-group-group-address-group-address-mask-source-address-source-address-mask_schema

static-group-group-address-group-address-mask-source-address-source-address-maskbody object

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address source-address-mask: string
in path

ID of group-address group-address-mask source-address source-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address-source-address-mask/{group-address group-address-mask source-address source-address-mask}/

Create operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask

static-group-group-address-group-address-mask-source-address-source-address-mask_schema

static-group-group-address-group-address-mask-source-address-source-address-maskbody object

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address source-address-mask: string
in path

ID of group-address group-address-mask source-address source-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address-source-address-mask/{group-address group-address-mask source-address source-address-mask}/

Delete operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address source-address-mask: string
in path

ID of group-address group-address-mask source-address source-address-mask

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address-source-address-mask/{group-address group-address-mask source-address source-address-mask}/

Retrieve operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address source-address-mask: string
in path

ID of group-address group-address-mask source-address source-address-mask

200 OK
static-group-group-address-group-address-mask-source-address-source-address-mask_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/maximum-groups-per-interface-oor/

Update operation of resource: maximum-groups-per-interface-oor

maximum-groups-per-interface-oor_schema

maximum-groups-per-interface-oorbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/maximum-groups-per-interface-oor/

Create operation of resource: maximum-groups-per-interface-oor

maximum-groups-per-interface-oor_schema

maximum-groups-per-interface-oorbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/maximum-groups-per-interface-oor/

Delete operation of resource: maximum-groups-per-interface-oor

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/maximum-groups-per-interface-oor/

Retrieve operation of resource: maximum-groups-per-interface-oor

interface-name: string
in path

ID of interface-name

200 OK
maximum-groups-per-interface-oor_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}

EXPLICIT-TRACKING - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/explicit-tracking/

Update operation of resource: explicit-tracking

explicit-tracking_schema

explicit-trackingbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/explicit-tracking/

Create operation of resource: explicit-tracking

explicit-tracking_schema

explicit-trackingbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/explicit-tracking/

Delete operation of resource: explicit-tracking

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:igmp/default-context/interfaces/interface/{interface-name}/explicit-tracking/

Retrieve operation of resource: explicit-tracking

interface-name: string
in path

ID of interface-name

200 OK
explicit-tracking_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}

AMT - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:amt/

Update operation of resource: amt

amt_schema

amtbody object

Request Content-Types: application/json
Request Example
{
  : {
amtPUTPOSTDELETEGET
    
"amtmtu": "integer", Configure AMT Relay MTU
range: "100..65535"

    
"amtttl": "integer", Configure AMT Relay TTL
range: "1..255"
    : {
Configure AMT Relay IPv4 Advertisement AddressPUTPOSTDELETEGET
      
"interface": "string", Relay Advertisement Interface

      
"address": "string" Anycast-Prefix Address

    },
    
"maximum-v6-route-gateway": "integer", Configure Maximum number of IPv6 route-gateways\n(Tunnels)
range: "1..4294967295"

    
"amtqqic": "integer", Configure AMT QQIC value
range: "1..4294967295"
    : {
Configure AMT Relay IPv4 Anycast-PrefixPUTPOSTDELETEGET
      
"prefix-length": "integer", Mask Length for Anycast Prefix
range: "1..32"

      
"address": "string" Anycast-Prefix Address

    },
    
"maximum-v4-routes": "integer", Configure Maximum number of IPv4 Routes
range: "1..4294967295"

    
"maximum-v4-route-gateway": "integer", Configure Maximum number of IPv4 route-gateways\n(Tunnels)
range: "1..4294967295"

    
"gateway-filter": "string", Access list for Gateway Filter

    
"maximum-gateway": "integer", Configure AMT maximum number of Gateways
range: "1..4294967295"

    
"amttos": "integer", Configure AMT Relay TOS
range: "1..255"

    
"maximum-v6-routes": "integer" Configure Maximum number of IPv6 Routes
range: "1..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AMT - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:amt/

Create operation of resource: amt

amt_schema

amtbody object

Request Content-Types: application/json
Request Example
{
  : {
amtPUTPOSTDELETEGET
    
"amtmtu": "integer", Configure AMT Relay MTU
range: "100..65535"

    
"amtttl": "integer", Configure AMT Relay TTL
range: "1..255"
    : {
Configure AMT Relay IPv4 Advertisement AddressPUTPOSTDELETEGET
      
"interface": "string", Relay Advertisement Interface

      
"address": "string" Anycast-Prefix Address

    },
    
"maximum-v6-route-gateway": "integer", Configure Maximum number of IPv6 route-gateways\n(Tunnels)
range: "1..4294967295"

    
"amtqqic": "integer", Configure AMT QQIC value
range: "1..4294967295"
    : {
Configure AMT Relay IPv4 Anycast-PrefixPUTPOSTDELETEGET
      
"prefix-length": "integer", Mask Length for Anycast Prefix
range: "1..32"

      
"address": "string" Anycast-Prefix Address

    },
    
"maximum-v4-routes": "integer", Configure Maximum number of IPv4 Routes
range: "1..4294967295"

    
"maximum-v4-route-gateway": "integer", Configure Maximum number of IPv4 route-gateways\n(Tunnels)
range: "1..4294967295"

    
"gateway-filter": "string", Access list for Gateway Filter

    
"maximum-gateway": "integer", Configure AMT maximum number of Gateways
range: "1..4294967295"

    
"amttos": "integer", Configure AMT Relay TOS
range: "1..255"

    
"maximum-v6-routes": "integer" Configure Maximum number of IPv6 Routes
range: "1..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AMT - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:amt/

Delete operation of resource: amt

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AMT - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:amt/

Retrieve operation of resource: amt

200 OK
amt_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
amtPUTPOSTDELETEGET
    
"amtmtu": "integer", Configure AMT Relay MTU
range: "100..65535"

    
"amtttl": "integer", Configure AMT Relay TTL
range: "1..255"
    : {
Configure AMT Relay IPv4 Advertisement AddressPUTPOSTDELETEGET
      
"interface": "string", Relay Advertisement Interface

      
"address": "string" Anycast-Prefix Address

    },
    
"maximum-v6-route-gateway": "integer", Configure Maximum number of IPv6 route-gateways\n(Tunnels)
range: "1..4294967295"

    
"amtqqic": "integer", Configure AMT QQIC value
range: "1..4294967295"
    : {
Configure AMT Relay IPv4 Anycast-PrefixPUTPOSTDELETEGET
      
"prefix-length": "integer", Mask Length for Anycast Prefix
range: "1..32"

      
"address": "string" Anycast-Prefix Address

    },
    
"maximum-v4-routes": "integer", Configure Maximum number of IPv4 Routes
range: "1..4294967295"

    
"maximum-v4-route-gateway": "integer", Configure Maximum number of IPv4 route-gateways\n(Tunnels)
range: "1..4294967295"

    
"gateway-filter": "string", Access list for Gateway Filter

    
"maximum-gateway": "integer", Configure AMT maximum number of Gateways
range: "1..4294967295"

    
"amttos": "integer", Configure AMT Relay TOS
range: "1..255"

    
"maximum-v6-routes": "integer" Configure Maximum number of IPv6 Routes
range: "1..4294967295"

  }
}

RELAY-ADV-ADD - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:amt/relay-adv-add/

Update operation of resource: relay-adv-add

relay-adv-add_schema

relay-adv-addbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure AMT Relay IPv4 Advertisement AddressPUTPOSTDELETEGET
    
"interface": "string", Relay Advertisement Interface

    
"address": "string" AMT Relay IPv4 Advertisement Address

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-ADV-ADD - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:amt/relay-adv-add/

Create operation of resource: relay-adv-add

relay-adv-add_schema

relay-adv-addbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure AMT Relay IPv4 Advertisement AddressPUTPOSTDELETEGET
    
"interface": "string", Relay Advertisement Interface

    
"address": "string" AMT Relay IPv4 Advertisement Address

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-ADV-ADD - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:amt/relay-adv-add/

Delete operation of resource: relay-adv-add

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-ADV-ADD - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:amt/relay-adv-add/

Retrieve operation of resource: relay-adv-add

200 OK
relay-adv-add_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure AMT Relay IPv4 Advertisement AddressPUTPOSTDELETEGET
    
"interface": "string", Relay Advertisement Interface

    
"address": "string" AMT Relay IPv4 Advertisement Address

  }
}

RELAY-ANYCAST-PREFIX - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:amt/relay-anycast-prefix/

Update operation of resource: relay-anycast-prefix

relay-anycast-prefix_schema

relay-anycast-prefixbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure AMT Relay IPv4 Anycast-PrefixPUTPOSTDELETEGET
    
"prefix-length": "integer", Mask Length for Anycast Prefix
range: "1..32"

    
"address": "string" Anycast-Prefix Address

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-ANYCAST-PREFIX - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:amt/relay-anycast-prefix/

Create operation of resource: relay-anycast-prefix

relay-anycast-prefix_schema

relay-anycast-prefixbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure AMT Relay IPv4 Anycast-PrefixPUTPOSTDELETEGET
    
"prefix-length": "integer", Mask Length for Anycast Prefix
range: "1..32"

    
"address": "string" Anycast-Prefix Address

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-ANYCAST-PREFIX - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:amt/relay-anycast-prefix/

Delete operation of resource: relay-anycast-prefix

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-ANYCAST-PREFIX - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:amt/relay-anycast-prefix/

Retrieve operation of resource: relay-anycast-prefix

200 OK
relay-anycast-prefix_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure AMT Relay IPv4 Anycast-PrefixPUTPOSTDELETEGET
    
"prefix-length": "integer", Mask Length for Anycast Prefix
range: "1..32"

    
"address": "string" Anycast-Prefix Address

  }
}

MLD - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/

Update operation of resource: mld

mld_schema

mldbody object

Request Content-Types: application/json
Request Example
{
  : {
mldPUTPOSTDELETEGET
    : {
VRF related configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Inheritable DefaultsPUTPOSTDELETEGET
            
"access-group": "string", Access list specifying access group range
            : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
              
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

              
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

              
"access-list-name": "string" Access-list to account for

            },
            : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
              
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

              
"access-list-name": "string" Access-list to account for

            },
            
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

            
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

            
"version": "integer", Version number
range: "1..3"
default: "3"

            
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

            
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

          },
          : {
IGMP Source specific modePUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"access-list-name": "string", Access-list to account for

                
"source-address": "string" IP source address

              }
            ]
          },
          
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

          
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
          : {
Configure IGMP State LimitsPUTPOSTDELETEGET
            
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          },
          
"vrf-name": "string", Name for this vrf
          : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
            
"profile": "string" Configure the route-policy profile

          },
          : {
Interface-level configurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"access-group": "string", Access list specifying access group range

                
"interface-name": "string", Name of the interface
                : {
IGMP join multicast groupPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"group-address": "string", IP group address

                      
"mode": "string" Filter mode

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-address": "string", IP group address

                      
"mode": "string", Filter mode

                      
"source-address": "string" IP source address

                    }
                  ]
                },
                : {
IGMP static multicast groupPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"group-address-mask": "string", Mask for Group Address

                      
"group-address": "string", IP group address

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"source-address": "string", IP source address

                      
"group-address-mask": "string", Mask for Group Address

                      
"source-address-mask": "string", Mask for Source Address

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"group-address": "string", IP group address

                      
"source-address": "string", IP source address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"source-address": "string", IP source address

                      
"group-address-mask": "string", Mask for Group Address

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"source-address": "string", IP source address

                      
"source-address-mask": "string", Mask for Source Address

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ]
                },
                
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
                : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
                  
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

                  
"access-list-name": "string" Access-list to account for

                },
                
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
                : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
                  
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

                  
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

                  
"access-list-name": "string" Access-list to account for

                },
                
"version": "integer", Version number
range: "1..3"
default: "3"

                
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

                
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

              }
            ]
          }
        }
      ]
    },
    : {
Default ContextPUTPOSTDELETEGET
      : {
Inheritable DefaultsPUTPOSTDELETEGET
        
"access-group": "string", Access list specifying access group range
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      },
      : {
Configure IGMP QoS shapers for subscriber\ninterfacesPUTPOSTDELETEGET
        
"download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"

        
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"

        
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"

      },
      : {
IGMP Source specific modePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-list-name": "string", Access-list to account for

            
"source-address": "string" IP source address

          }
        ]
      },
      
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

      
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
      : {
Configure IGMP State LimitsPUTPOSTDELETEGET
        
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      },
      : {
Configure NSF specific optionsPUTPOSTDELETEGET
        
"lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"

      },
      : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
        
"profile": "string" Configure the route-policy profile

      },
      : {
Configure IGMP accounting for logging\njoin/leave recordsPUTPOSTDELETEGET
        
"max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"

      },
      : {
Interface-level configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-group": "string", Access list specifying access group range

            
"interface-name": "string", Name of the interface
            : {
IGMP join multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string" Filter mode

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string", Filter mode

                  
"source-address": "string" IP source address

                }
              ]
            },
            : {
IGMP static multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"source-address": "string", IP source address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ]
            },
            
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
            : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
              
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

              
"access-list-name": "string" Access-list to account for

            },
            
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
            : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
              
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

              
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

              
"access-list-name": "string" Access-list to account for

            },
            
"version": "integer", Version number
range: "1..3"
default: "3"

            
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

            
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

          }
        ]
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MLD - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/

Create operation of resource: mld

mld_schema

mldbody object

Request Content-Types: application/json
Request Example
{
  : {
mldPUTPOSTDELETEGET
    : {
VRF related configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Inheritable DefaultsPUTPOSTDELETEGET
            
"access-group": "string", Access list specifying access group range
            : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
              
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

              
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

              
"access-list-name": "string" Access-list to account for

            },
            : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
              
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

              
"access-list-name": "string" Access-list to account for

            },
            
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

            
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

            
"version": "integer", Version number
range: "1..3"
default: "3"

            
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

            
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

          },
          : {
IGMP Source specific modePUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"access-list-name": "string", Access-list to account for

                
"source-address": "string" IP source address

              }
            ]
          },
          
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

          
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
          : {
Configure IGMP State LimitsPUTPOSTDELETEGET
            
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          },
          
"vrf-name": "string", Name for this vrf
          : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
            
"profile": "string" Configure the route-policy profile

          },
          : {
Interface-level configurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"access-group": "string", Access list specifying access group range

                
"interface-name": "string", Name of the interface
                : {
IGMP join multicast groupPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"group-address": "string", IP group address

                      
"mode": "string" Filter mode

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-address": "string", IP group address

                      
"mode": "string", Filter mode

                      
"source-address": "string" IP source address

                    }
                  ]
                },
                : {
IGMP static multicast groupPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"group-address-mask": "string", Mask for Group Address

                      
"group-address": "string", IP group address

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"source-address": "string", IP source address

                      
"group-address-mask": "string", Mask for Group Address

                      
"source-address-mask": "string", Mask for Source Address

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"group-address": "string", IP group address

                      
"source-address": "string", IP source address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"source-address": "string", IP source address

                      
"group-address-mask": "string", Mask for Group Address

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"source-address": "string", IP source address

                      
"source-address-mask": "string", Mask for Source Address

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ]
                },
                
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
                : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
                  
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

                  
"access-list-name": "string" Access-list to account for

                },
                
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
                : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
                  
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

                  
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

                  
"access-list-name": "string" Access-list to account for

                },
                
"version": "integer", Version number
range: "1..3"
default: "3"

                
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

                
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

              }
            ]
          }
        }
      ]
    },
    : {
Default ContextPUTPOSTDELETEGET
      : {
Inheritable DefaultsPUTPOSTDELETEGET
        
"access-group": "string", Access list specifying access group range
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      },
      : {
Configure IGMP QoS shapers for subscriber\ninterfacesPUTPOSTDELETEGET
        
"download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"

        
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"

        
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"

      },
      : {
IGMP Source specific modePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-list-name": "string", Access-list to account for

            
"source-address": "string" IP source address

          }
        ]
      },
      
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

      
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
      : {
Configure IGMP State LimitsPUTPOSTDELETEGET
        
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      },
      : {
Configure NSF specific optionsPUTPOSTDELETEGET
        
"lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"

      },
      : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
        
"profile": "string" Configure the route-policy profile

      },
      : {
Configure IGMP accounting for logging\njoin/leave recordsPUTPOSTDELETEGET
        
"max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"

      },
      : {
Interface-level configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-group": "string", Access list specifying access group range

            
"interface-name": "string", Name of the interface
            : {
IGMP join multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string" Filter mode

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string", Filter mode

                  
"source-address": "string" IP source address

                }
              ]
            },
            : {
IGMP static multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"source-address": "string", IP source address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ]
            },
            
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
            : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
              
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

              
"access-list-name": "string" Access-list to account for

            },
            
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
            : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
              
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

              
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

              
"access-list-name": "string" Access-list to account for

            },
            
"version": "integer", Version number
range: "1..3"
default: "3"

            
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

            
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

          }
        ]
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MLD - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/

Delete operation of resource: mld

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MLD - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/

Retrieve operation of resource: mld

200 OK
mld_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
mldPUTPOSTDELETEGET
    : {
VRF related configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Inheritable DefaultsPUTPOSTDELETEGET
            
"access-group": "string", Access list specifying access group range
            : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
              
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

              
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

              
"access-list-name": "string" Access-list to account for

            },
            : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
              
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

              
"access-list-name": "string" Access-list to account for

            },
            
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

            
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

            
"version": "integer", Version number
range: "1..3"
default: "3"

            
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

            
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

          },
          : {
IGMP Source specific modePUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"access-list-name": "string", Access-list to account for

                
"source-address": "string" IP source address

              }
            ]
          },
          
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

          
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
          : {
Configure IGMP State LimitsPUTPOSTDELETEGET
            
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          },
          
"vrf-name": "string", Name for this vrf
          : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
            
"profile": "string" Configure the route-policy profile

          },
          : {
Interface-level configurationPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"access-group": "string", Access list specifying access group range

                
"interface-name": "string", Name of the interface
                : {
IGMP join multicast groupPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"group-address": "string", IP group address

                      
"mode": "string" Filter mode

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-address": "string", IP group address

                      
"mode": "string", Filter mode

                      
"source-address": "string" IP source address

                    }
                  ]
                },
                : {
IGMP static multicast groupPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"group-address-mask": "string", Mask for Group Address

                      
"group-address": "string", IP group address

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"source-address": "string", IP source address

                      
"group-address-mask": "string", Mask for Group Address

                      
"source-address-mask": "string", Mask for Source Address

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"group-address": "string", IP group address

                      
"source-address": "string", IP source address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"source-address": "string", IP source address

                      
"group-address-mask": "string", Mask for Group Address

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"source-address": "string", IP source address

                      
"source-address-mask": "string", Mask for Source Address

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ],
                  : [
 PUTPOSTDELETEGET
                    {
                      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                      
"group-address": "string", IP group address

                      
"suppress-report": "boolean" Suppress reports

                    }
                  ]
                },
                
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
                : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
                  
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

                  
"access-list-name": "string" Access-list to account for

                },
                
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
                : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
                  
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

                  
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

                  
"access-list-name": "string" Access-list to account for

                },
                
"version": "integer", Version number
range: "1..3"
default: "3"

                
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

                
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

              }
            ]
          }
        }
      ]
    },
    : {
Default ContextPUTPOSTDELETEGET
      : {
Inheritable DefaultsPUTPOSTDELETEGET
        
"access-group": "string", Access list specifying access group range
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      },
      : {
Configure IGMP QoS shapers for subscriber\ninterfacesPUTPOSTDELETEGET
        
"download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"

        
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"

        
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"

      },
      : {
IGMP Source specific modePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-list-name": "string", Access-list to account for

            
"source-address": "string" IP source address

          }
        ]
      },
      
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

      
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
      : {
Configure IGMP State LimitsPUTPOSTDELETEGET
        
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      },
      : {
Configure NSF specific optionsPUTPOSTDELETEGET
        
"lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"

      },
      : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
        
"profile": "string" Configure the route-policy profile

      },
      : {
Configure IGMP accounting for logging\njoin/leave recordsPUTPOSTDELETEGET
        
"max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"

      },
      : {
Interface-level configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-group": "string", Access list specifying access group range

            
"interface-name": "string", Name of the interface
            : {
IGMP join multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string" Filter mode

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string", Filter mode

                  
"source-address": "string" IP source address

                }
              ]
            },
            : {
IGMP static multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"source-address": "string", IP source address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ]
            },
            
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
            : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
              
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

              
"access-list-name": "string" Access-list to account for

            },
            
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
            : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
              
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

              
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

              
"access-list-name": "string" Access-list to account for

            },
            
"version": "integer", Version number
range: "1..3"
default: "3"

            
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

            
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

          }
        ]
      }
    }
  }
}

VRFS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/

Update operation of resource: vrfs

vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : {
VRF related configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Inheritable DefaultsPUTPOSTDELETEGET
          
"access-group": "string", Access list specifying access group range
          : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
            
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

            
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

            
"access-list-name": "string" Access-list to account for

          },
          : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
            
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

            
"access-list-name": "string" Access-list to account for

          },
          
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

          
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

          
"version": "integer", Version number
range: "1..3"
default: "3"

          
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

          
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

        },
        : {
IGMP Source specific modePUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"access-list-name": "string", Access-list to account for

              
"source-address": "string" IP source address

            }
          ]
        },
        
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

        
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
        : {
Configure IGMP State LimitsPUTPOSTDELETEGET
          
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        },
        
"vrf-name": "string", Name for this vrf
        : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
          
"profile": "string" Configure the route-policy profile

        },
        : {
Interface-level configurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"access-group": "string", Access list specifying access group range

              
"interface-name": "string", Name of the interface
              : {
IGMP join multicast groupPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"group-address": "string", IP group address

                    
"mode": "string" Filter mode

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-address": "string", IP group address

                    
"mode": "string", Filter mode

                    
"source-address": "string" IP source address

                  }
                ]
              },
              : {
IGMP static multicast groupPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"group-address-mask": "string", Mask for Group Address

                    
"group-address": "string", IP group address

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"source-address": "string", IP source address

                    
"group-address-mask": "string", Mask for Group Address

                    
"source-address-mask": "string", Mask for Source Address

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"group-address": "string", IP group address

                    
"source-address": "string", IP source address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"source-address": "string", IP source address

                    
"group-address-mask": "string", Mask for Group Address

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"source-address": "string", IP source address

                    
"source-address-mask": "string", Mask for Source Address

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ]
              },
              
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
              : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
                
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

                
"access-list-name": "string" Access-list to account for

              },
              
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
              : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
                
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

                
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

                
"access-list-name": "string" Access-list to account for

              },
              
"version": "integer", Version number
range: "1..3"
default: "3"

              
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

              
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/

Create operation of resource: vrfs

vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : {
VRF related configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Inheritable DefaultsPUTPOSTDELETEGET
          
"access-group": "string", Access list specifying access group range
          : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
            
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

            
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

            
"access-list-name": "string" Access-list to account for

          },
          : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
            
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

            
"access-list-name": "string" Access-list to account for

          },
          
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

          
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

          
"version": "integer", Version number
range: "1..3"
default: "3"

          
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

          
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

        },
        : {
IGMP Source specific modePUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"access-list-name": "string", Access-list to account for

              
"source-address": "string" IP source address

            }
          ]
        },
        
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

        
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
        : {
Configure IGMP State LimitsPUTPOSTDELETEGET
          
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        },
        
"vrf-name": "string", Name for this vrf
        : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
          
"profile": "string" Configure the route-policy profile

        },
        : {
Interface-level configurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"access-group": "string", Access list specifying access group range

              
"interface-name": "string", Name of the interface
              : {
IGMP join multicast groupPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"group-address": "string", IP group address

                    
"mode": "string" Filter mode

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-address": "string", IP group address

                    
"mode": "string", Filter mode

                    
"source-address": "string" IP source address

                  }
                ]
              },
              : {
IGMP static multicast groupPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"group-address-mask": "string", Mask for Group Address

                    
"group-address": "string", IP group address

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"source-address": "string", IP source address

                    
"group-address-mask": "string", Mask for Group Address

                    
"source-address-mask": "string", Mask for Source Address

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"group-address": "string", IP group address

                    
"source-address": "string", IP source address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"source-address": "string", IP source address

                    
"group-address-mask": "string", Mask for Group Address

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"source-address": "string", IP source address

                    
"source-address-mask": "string", Mask for Source Address

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ]
              },
              
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
              : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
                
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

                
"access-list-name": "string" Access-list to account for

              },
              
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
              : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
                
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

                
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

                
"access-list-name": "string" Access-list to account for

              },
              
"version": "integer", Version number
range: "1..3"
default: "3"

              
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

              
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/

Delete operation of resource: vrfs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/

Retrieve operation of resource: vrfs

200 OK
vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
VRF related configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Inheritable DefaultsPUTPOSTDELETEGET
          
"access-group": "string", Access list specifying access group range
          : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
            
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

            
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

            
"access-list-name": "string" Access-list to account for

          },
          : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
            
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

            
"access-list-name": "string" Access-list to account for

          },
          
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

          
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

          
"version": "integer", Version number
range: "1..3"
default: "3"

          
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

          
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

        },
        : {
IGMP Source specific modePUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"access-list-name": "string", Access-list to account for

              
"source-address": "string" IP source address

            }
          ]
        },
        
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

        
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
        : {
Configure IGMP State LimitsPUTPOSTDELETEGET
          
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        },
        
"vrf-name": "string", Name for this vrf
        : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
          
"profile": "string" Configure the route-policy profile

        },
        : {
Interface-level configurationPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"access-group": "string", Access list specifying access group range

              
"interface-name": "string", Name of the interface
              : {
IGMP join multicast groupPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"group-address": "string", IP group address

                    
"mode": "string" Filter mode

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-address": "string", IP group address

                    
"mode": "string", Filter mode

                    
"source-address": "string" IP source address

                  }
                ]
              },
              : {
IGMP static multicast groupPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"group-address-mask": "string", Mask for Group Address

                    
"group-address": "string", IP group address

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"source-address": "string", IP source address

                    
"group-address-mask": "string", Mask for Group Address

                    
"source-address-mask": "string", Mask for Source Address

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"group-address": "string", IP group address

                    
"source-address": "string", IP source address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"source-address": "string", IP source address

                    
"group-address-mask": "string", Mask for Group Address

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"source-address": "string", IP source address

                    
"source-address-mask": "string", Mask for Source Address

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ],
                : [
 PUTPOSTDELETEGET
                  {
                    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                    
"group-address": "string", IP group address

                    
"suppress-report": "boolean" Suppress reports

                  }
                ]
              },
              
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
              : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
                
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

                
"access-list-name": "string" Access-list to account for

              },
              
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
              : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
                
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

                
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

                
"access-list-name": "string" Access-list to account for

              },
              
"version": "integer", Version number
range: "1..3"
default: "3"

              
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

              
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

            }
          ]
        }
      }
    ]
  }
}

VRF - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/

Update operation of resource: vrf

vrf_schema

vrfbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Inheritable DefaultsPUTPOSTDELETEGET
        
"access-group": "string", Access list specifying access group range
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      },
      : {
IGMP Source specific modePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-list-name": "string", Access-list to account for

            
"source-address": "string" IP source address

          }
        ]
      },
      
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

      
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
      : {
Configure IGMP State LimitsPUTPOSTDELETEGET
        
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      },
      
"vrf-name": "string", Name for this vrf
      : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
        
"profile": "string" Configure the route-policy profile

      },
      : {
Interface-level configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-group": "string", Access list specifying access group range

            
"interface-name": "string", Name of the interface
            : {
IGMP join multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string" Filter mode

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string", Filter mode

                  
"source-address": "string" IP source address

                }
              ]
            },
            : {
IGMP static multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"source-address": "string", IP source address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ]
            },
            
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
            : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
              
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

              
"access-list-name": "string" Access-list to account for

            },
            
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
            : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
              
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

              
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

              
"access-list-name": "string" Access-list to account for

            },
            
"version": "integer", Version number
range: "1..3"
default: "3"

            
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

            
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/

Create operation of resource: vrf

vrf_schema

vrfbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Inheritable DefaultsPUTPOSTDELETEGET
        
"access-group": "string", Access list specifying access group range
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      },
      : {
IGMP Source specific modePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-list-name": "string", Access-list to account for

            
"source-address": "string" IP source address

          }
        ]
      },
      
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

      
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
      : {
Configure IGMP State LimitsPUTPOSTDELETEGET
        
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      },
      
"vrf-name": "string", Name for this vrf
      : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
        
"profile": "string" Configure the route-policy profile

      },
      : {
Interface-level configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-group": "string", Access list specifying access group range

            
"interface-name": "string", Name of the interface
            : {
IGMP join multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string" Filter mode

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string", Filter mode

                  
"source-address": "string" IP source address

                }
              ]
            },
            : {
IGMP static multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"source-address": "string", IP source address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ]
            },
            
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
            : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
              
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

              
"access-list-name": "string" Access-list to account for

            },
            
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
            : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
              
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

              
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

              
"access-list-name": "string" Access-list to account for

            },
            
"version": "integer", Version number
range: "1..3"
default: "3"

            
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

            
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/

Delete operation of resource: vrf

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/

Retrieve operation of resource: vrf

vrf-name: string
in path

ID of vrf-name

200 OK
vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Inheritable DefaultsPUTPOSTDELETEGET
        
"access-group": "string", Access list specifying access group range
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      },
      : {
IGMP Source specific modePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-list-name": "string", Access-list to account for

            
"source-address": "string" IP source address

          }
        ]
      },
      
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

      
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
      : {
Configure IGMP State LimitsPUTPOSTDELETEGET
        
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      },
      
"vrf-name": "string", Name for this vrf
      : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
        
"profile": "string" Configure the route-policy profile

      },
      : {
Interface-level configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"access-group": "string", Access list specifying access group range

            
"interface-name": "string", Name of the interface
            : {
IGMP join multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string" Filter mode

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-address": "string", IP group address

                  
"mode": "string", Filter mode

                  
"source-address": "string" IP source address

                }
              ]
            },
            : {
IGMP static multicast groupPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"source-address": "string", IP source address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"group-address-mask": "string", Mask for Group Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"source-address": "string", IP source address

                  
"source-address-mask": "string", Mask for Source Address

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ],
              : [
 PUTPOSTDELETEGET
                {
                  
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                  
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                  
"group-address": "string", IP group address

                  
"suppress-report": "boolean" Suppress reports

                }
              ]
            },
            
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
            : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
              
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

              
"access-list-name": "string" Access-list to account for

            },
            
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
            : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
              
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

              
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

              
"access-list-name": "string" Access-list to account for

            },
            
"version": "integer", Version number
range: "1..3"
default: "3"

            
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

            
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

          }
        ]
      }
    }
  ]
}

TRAFFIC - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/traffic/

Update operation of resource: traffic

traffic_schema

trafficbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
    
"profile": "string" Configure the route-policy profile

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/traffic/

Create operation of resource: traffic

traffic_schema

trafficbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
    
"profile": "string" Configure the route-policy profile

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/traffic/

Delete operation of resource: traffic

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/traffic/

Retrieve operation of resource: traffic

vrf-name: string
in path

ID of vrf-name

200 OK
traffic_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
    
"profile": "string" Configure the route-policy profile

  }
}

INHERITABLE-DEFAULTS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/inheritable-defaults/

Update operation of resource: inheritable-defaults

inheritable-defaults_schema

inheritable-defaultsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Inheritable DefaultsPUTPOSTDELETEGET
    
"access-group": "string", Access list specifying access group range
    : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
      
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

      
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      
"access-list-name": "string" Access list specifying tracking group range

    },
    : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
      
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

      
"access-list-name": "string" Access list specifying tracking group range

    },
    
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

    
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

    
"version": "integer", Version number
range: "1..3"
default: "3"

    
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

    
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/inheritable-defaults/

Create operation of resource: inheritable-defaults

inheritable-defaults_schema

inheritable-defaultsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Inheritable DefaultsPUTPOSTDELETEGET
    
"access-group": "string", Access list specifying access group range
    : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
      
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

      
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      
"access-list-name": "string" Access list specifying tracking group range

    },
    : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
      
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

      
"access-list-name": "string" Access list specifying tracking group range

    },
    
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

    
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

    
"version": "integer", Version number
range: "1..3"
default: "3"

    
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

    
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/inheritable-defaults/

Delete operation of resource: inheritable-defaults

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/inheritable-defaults/

Retrieve operation of resource: inheritable-defaults

vrf-name: string
in path

ID of vrf-name

200 OK
inheritable-defaults_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Inheritable DefaultsPUTPOSTDELETEGET
    
"access-group": "string", Access list specifying access group range
    : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
      
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

      
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      
"access-list-name": "string" Access list specifying tracking group range

    },
    : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
      
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

      
"access-list-name": "string" Access list specifying tracking group range

    },
    
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

    
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

    
"version": "integer", Version number
range: "1..3"
default: "3"

    
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

    
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

  }
}

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/inheritable-defaults/maximum-groups-per-interface-oor/

Update operation of resource: maximum-groups-per-interface-oor

maximum-groups-per-interface-oor_schema

maximum-groups-per-interface-oorbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/inheritable-defaults/maximum-groups-per-interface-oor/

Create operation of resource: maximum-groups-per-interface-oor

maximum-groups-per-interface-oor_schema

maximum-groups-per-interface-oorbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/inheritable-defaults/maximum-groups-per-interface-oor/

Delete operation of resource: maximum-groups-per-interface-oor

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/inheritable-defaults/maximum-groups-per-interface-oor/

Retrieve operation of resource: maximum-groups-per-interface-oor

vrf-name: string
in path

ID of vrf-name

200 OK
maximum-groups-per-interface-oor_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}

EXPLICIT-TRACKING - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/inheritable-defaults/explicit-tracking/

Update operation of resource: explicit-tracking

explicit-tracking_schema

explicit-trackingbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/inheritable-defaults/explicit-tracking/

Create operation of resource: explicit-tracking

explicit-tracking_schema

explicit-trackingbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/inheritable-defaults/explicit-tracking/

Delete operation of resource: explicit-tracking

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/inheritable-defaults/explicit-tracking/

Retrieve operation of resource: explicit-tracking

vrf-name: string
in path

ID of vrf-name

200 OK
explicit-tracking_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}

SSM-ACCESS-GROUPS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/ssm-access-groups/

Update operation of resource: ssm-access-groups

ssm-access-groups_schema

ssm-access-groupsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP Source specific modePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-list-name": "string", Access list specifying access group

        
"source-address": "string" IP source address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUPS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/ssm-access-groups/

Create operation of resource: ssm-access-groups

ssm-access-groups_schema

ssm-access-groupsbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP Source specific modePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-list-name": "string", Access list specifying access group

        
"source-address": "string" IP source address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUPS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/ssm-access-groups/

Delete operation of resource: ssm-access-groups

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUPS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/ssm-access-groups/

Retrieve operation of resource: ssm-access-groups

vrf-name: string
in path

ID of vrf-name

200 OK
ssm-access-groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMP Source specific modePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-list-name": "string", Access list specifying access group

        
"source-address": "string" IP source address

      }
    ]
  }
}

SSM-ACCESS-GROUP - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/ssm-access-groups/ssm-access-group/{source-address}/

Update operation of resource: ssm-access-group

ssm-access-group_schema

ssm-access-groupbody object

vrf-name: string
in path

ID of vrf-name

source-address: string
in path

ID of source-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-list-name": "string", Access list specifying access group

      
"source-address": "string" IP source address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUP - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/ssm-access-groups/ssm-access-group/{source-address}/

Create operation of resource: ssm-access-group

ssm-access-group_schema

ssm-access-groupbody object

vrf-name: string
in path

ID of vrf-name

source-address: string
in path

ID of source-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-list-name": "string", Access list specifying access group

      
"source-address": "string" IP source address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUP - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/ssm-access-groups/ssm-access-group/{source-address}/

Delete operation of resource: ssm-access-group

vrf-name: string
in path

ID of vrf-name

source-address: string
in path

ID of source-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUP - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/ssm-access-groups/ssm-access-group/{source-address}/

Retrieve operation of resource: ssm-access-group

vrf-name: string
in path

ID of vrf-name

source-address: string
in path

ID of source-address

200 OK
ssm-access-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-list-name": "string", Access list specifying access group

      
"source-address": "string" IP source address

    }
  ]
}

MAXIMUM - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/maximum/

Update operation of resource: maximum

maximum_schema

maximumbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP State LimitsPUTPOSTDELETEGET
    
"maximum-groups": "integer" Configure maximum number of groups accepted by\nthis router
range: "1..40000"
default: "50000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/maximum/

Create operation of resource: maximum

maximum_schema

maximumbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP State LimitsPUTPOSTDELETEGET
    
"maximum-groups": "integer" Configure maximum number of groups accepted by\nthis router
range: "1..40000"
default: "50000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/maximum/

Delete operation of resource: maximum

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/maximum/

Retrieve operation of resource: maximum

vrf-name: string
in path

ID of vrf-name

200 OK
maximum_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IGMP State LimitsPUTPOSTDELETEGET
    
"maximum-groups": "integer" Configure maximum number of groups accepted by\nthis router
range: "1..40000"
default: "50000"

  }
}

INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/

Update operation of resource: interfaces

interfaces_schema

interfacesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Interface-level configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-group": "string", Access list specifying access group range

        
"interface-name": "string", Name of the interface
        : {
IGMP join multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string" Filter mode

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string", Filter mode

              
"source-address": "string" IP source address

            }
          ]
        },
        : {
IGMP static multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"source-address": "string", IP source address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ]
        },
        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/

Create operation of resource: interfaces

interfaces_schema

interfacesbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  : {
Interface-level configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-group": "string", Access list specifying access group range

        
"interface-name": "string", Name of the interface
        : {
IGMP join multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string" Filter mode

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string", Filter mode

              
"source-address": "string" IP source address

            }
          ]
        },
        : {
IGMP static multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"source-address": "string", IP source address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ]
        },
        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/

Delete operation of resource: interfaces

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/

Retrieve operation of resource: interfaces

vrf-name: string
in path

ID of vrf-name

200 OK
interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Interface-level configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-group": "string", Access list specifying access group range

        
"interface-name": "string", Name of the interface
        : {
IGMP join multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string" Filter mode

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string", Filter mode

              
"source-address": "string" IP source address

            }
          ]
        },
        : {
IGMP static multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"source-address": "string", IP source address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ]
        },
        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      }
    ]
  }
}

INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/

Update operation of resource: interface

interface_schema

interfacebody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-group": "string", Access list specifying access group range

      
"interface-name": "string", Name of the interface
      : {
IGMP join multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string" Filter mode

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string", Filter mode

            
"source-address": "string" IP source address

          }
        ]
      },
      : {
IGMP static multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"source-address": "string", IP source address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ]
      },
      
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
      : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
        
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

        
"access-list-name": "string" Access-list to account for

      },
      
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
      : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
        
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

        
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        
"access-list-name": "string" Access-list to account for

      },
      
"version": "integer", Version number
range: "1..3"
default: "3"

      
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

      
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/

Create operation of resource: interface

interface_schema

interfacebody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-group": "string", Access list specifying access group range

      
"interface-name": "string", Name of the interface
      : {
IGMP join multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string" Filter mode

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string", Filter mode

            
"source-address": "string" IP source address

          }
        ]
      },
      : {
IGMP static multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"source-address": "string", IP source address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ]
      },
      
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
      : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
        
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

        
"access-list-name": "string" Access-list to account for

      },
      
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
      : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
        
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

        
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        
"access-list-name": "string" Access-list to account for

      },
      
"version": "integer", Version number
range: "1..3"
default: "3"

      
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

      
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/

Delete operation of resource: interface

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/

Retrieve operation of resource: interface

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK
interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-group": "string", Access list specifying access group range

      
"interface-name": "string", Name of the interface
      : {
IGMP join multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string" Filter mode

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string", Filter mode

            
"source-address": "string" IP source address

          }
        ]
      },
      : {
IGMP static multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"source-address": "string", IP source address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ]
      },
      
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
      : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
        
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

        
"access-list-name": "string" Access-list to account for

      },
      
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
      : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
        
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

        
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        
"access-list-name": "string" Access-list to account for

      },
      
"version": "integer", Version number
range: "1..3"
default: "3"

      
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

      
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

    }
  ]
}

JOIN-GROUPS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/

Update operation of resource: join-groups

join-groups_schema

join-groupsbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP join multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string" Filter mode

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string", Filter mode

        
"source-address": "string" Optional IP source address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUPS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/

Create operation of resource: join-groups

join-groups_schema

join-groupsbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP join multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string" Filter mode

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string", Filter mode

        
"source-address": "string" Optional IP source address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUPS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/

Delete operation of resource: join-groups

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUPS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/

Retrieve operation of resource: join-groups

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK
join-groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMP join multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string" Filter mode

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string", Filter mode

        
"source-address": "string" Optional IP source address

      }
    ]
  }
}

JOIN-GROUP - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/join-group/{group-address}/

Update operation of resource: join-group

join-group_schema

join-groupbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string" Filter mode

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string", Filter mode

      
"source-address": "string" Optional IP source address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/join-group/{group-address}/

Create operation of resource: join-group

join-group_schema

join-groupbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string" Filter mode

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string", Filter mode

      
"source-address": "string" Optional IP source address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/join-group/{group-address}/

Delete operation of resource: join-group

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/join-group/{group-address}/

Retrieve operation of resource: join-group

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

200 OK
join-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string" Filter mode

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string", Filter mode

      
"source-address": "string" Optional IP source address

    }
  ]
}

JOIN-GROUP-SOURCE-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/join-group-source-address/{group-address source-address}/

Update operation of resource: join-group-source-address

join-group-source-address_schema

join-group-source-addressbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-address": "string", IP group address

    
"mode": "string", Filter mode

    
"source-address": "string" Optional IP source address

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP-SOURCE-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/join-group-source-address/{group-address source-address}/

Create operation of resource: join-group-source-address

join-group-source-address_schema

join-group-source-addressbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-address": "string", IP group address

    
"mode": "string", Filter mode

    
"source-address": "string" Optional IP source address

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP-SOURCE-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/join-group-source-address/{group-address source-address}/

Delete operation of resource: join-group-source-address

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP-SOURCE-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/join-groups/join-group-source-address/{group-address source-address}/

Retrieve operation of resource: join-group-source-address

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

200 OK
join-group-source-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-address": "string", IP group address

    
"mode": "string", Filter mode

    
"source-address": "string" Optional IP source address

  }
}

STATIC-GROUP-GROUP-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/

Update operation of resource: static-group-group-addresses

static-group-group-addresses_schema

static-group-group-addressesbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP static multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"source-address": "string", IP source address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/

Create operation of resource: static-group-group-addresses

static-group-group-addresses_schema

static-group-group-addressesbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP static multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"source-address": "string", IP source address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/

Delete operation of resource: static-group-group-addresses

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/

Retrieve operation of resource: static-group-group-addresses

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK
static-group-group-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMP static multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"source-address": "string", IP source address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ]
  }
}

STATIC-GROUP-GROUP-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address/{group-address}/

Update operation of resource: static-group-group-address

static-group-group-address_schema

static-group-group-addressbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"source-address": "string", IP source address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address/{group-address}/

Create operation of resource: static-group-group-address

static-group-group-address_schema

static-group-group-addressbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"source-address": "string", IP source address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address/{group-address}/

Delete operation of resource: static-group-group-address

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address/{group-address}/

Retrieve operation of resource: static-group-group-address

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

200 OK
static-group-group-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"source-address": "string", IP source address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ]
}

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address/{group-address source-address}/

Update operation of resource: static-group-group-address-source-address

static-group-group-address-source-address_schema

static-group-group-address-source-addressbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"group-address": "string", IP group address

    
"source-address": "string", IP source address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address/{group-address source-address}/

Create operation of resource: static-group-group-address-source-address

static-group-group-address-source-address_schema

static-group-group-address-source-addressbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"group-address": "string", IP group address

    
"source-address": "string", IP source address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address/{group-address source-address}/

Delete operation of resource: static-group-group-address-source-address

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address/{group-address source-address}/

Retrieve operation of resource: static-group-group-address-source-address

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

200 OK
static-group-group-address-source-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"group-address": "string", IP group address

    
"source-address": "string", IP source address

    
"suppress-report": "boolean" Suppress reports

  }
}

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address-source-address-mask/{group-address source-address source-address-mask}/

Update operation of resource: static-group-group-address-source-address-source-address-mask

static-group-group-address-source-address-source-address-mask_schema

static-group-group-address-source-address-source-address-maskbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address source-address-mask: string
in path

ID of group-address source-address source-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address-source-address-mask/{group-address source-address source-address-mask}/

Create operation of resource: static-group-group-address-source-address-source-address-mask

static-group-group-address-source-address-source-address-mask_schema

static-group-group-address-source-address-source-address-maskbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address source-address-mask: string
in path

ID of group-address source-address source-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address-source-address-mask/{group-address source-address source-address-mask}/

Delete operation of resource: static-group-group-address-source-address-source-address-mask

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address source-address-mask: string
in path

ID of group-address source-address source-address-mask

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address-source-address-mask/{group-address source-address source-address-mask}/

Retrieve operation of resource: static-group-group-address-source-address-source-address-mask

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address source-address source-address-mask: string
in path

ID of group-address source-address source-address-mask

200 OK
static-group-group-address-source-address-source-address-mask_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask/{group-address group-address-mask}/

Update operation of resource: static-group-group-address-group-address-mask

static-group-group-address-group-address-mask_schema

static-group-group-address-group-address-maskbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask: string
in path

ID of group-address group-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask/{group-address group-address-mask}/

Create operation of resource: static-group-group-address-group-address-mask

static-group-group-address-group-address-mask_schema

static-group-group-address-group-address-maskbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask: string
in path

ID of group-address group-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask/{group-address group-address-mask}/

Delete operation of resource: static-group-group-address-group-address-mask

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask: string
in path

ID of group-address group-address-mask

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask/{group-address group-address-mask}/

Retrieve operation of resource: static-group-group-address-group-address-mask

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask: string
in path

ID of group-address group-address-mask

200 OK
static-group-group-address-group-address-mask_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"suppress-report": "boolean" Suppress reports

  }
}

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address/{group-address group-address-mask source-address}/

Update operation of resource: static-group-group-address-group-address-mask-source-address

static-group-group-address-group-address-mask-source-address_schema

static-group-group-address-group-address-mask-source-addressbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address: string
in path

ID of group-address group-address-mask source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address/{group-address group-address-mask source-address}/

Create operation of resource: static-group-group-address-group-address-mask-source-address

static-group-group-address-group-address-mask-source-address_schema

static-group-group-address-group-address-mask-source-addressbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address: string
in path

ID of group-address group-address-mask source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address/{group-address group-address-mask source-address}/

Delete operation of resource: static-group-group-address-group-address-mask-source-address

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address: string
in path

ID of group-address group-address-mask source-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address/{group-address group-address-mask source-address}/

Retrieve operation of resource: static-group-group-address-group-address-mask-source-address

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address: string
in path

ID of group-address group-address-mask source-address

200 OK
static-group-group-address-group-address-mask-source-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address-source-address-mask/{group-address group-address-mask source-address source-address-mask}/

Update operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask

static-group-group-address-group-address-mask-source-address-source-address-mask_schema

static-group-group-address-group-address-mask-source-address-source-address-maskbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address source-address-mask: string
in path

ID of group-address group-address-mask source-address source-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address-source-address-mask/{group-address group-address-mask source-address source-address-mask}/

Create operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask

static-group-group-address-group-address-mask-source-address-source-address-mask_schema

static-group-group-address-group-address-mask-source-address-source-address-maskbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address source-address-mask: string
in path

ID of group-address group-address-mask source-address source-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address-source-address-mask/{group-address group-address-mask source-address source-address-mask}/

Delete operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address source-address-mask: string
in path

ID of group-address group-address-mask source-address source-address-mask

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address-source-address-mask/{group-address group-address-mask source-address source-address-mask}/

Retrieve operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address source-address-mask: string
in path

ID of group-address group-address-mask source-address source-address-mask

200 OK
static-group-group-address-group-address-mask-source-address-source-address-mask_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/maximum-groups-per-interface-oor/

Update operation of resource: maximum-groups-per-interface-oor

maximum-groups-per-interface-oor_schema

maximum-groups-per-interface-oorbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/maximum-groups-per-interface-oor/

Create operation of resource: maximum-groups-per-interface-oor

maximum-groups-per-interface-oor_schema

maximum-groups-per-interface-oorbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/maximum-groups-per-interface-oor/

Delete operation of resource: maximum-groups-per-interface-oor

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/maximum-groups-per-interface-oor/

Retrieve operation of resource: maximum-groups-per-interface-oor

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK
maximum-groups-per-interface-oor_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}

EXPLICIT-TRACKING - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/explicit-tracking/

Update operation of resource: explicit-tracking

explicit-tracking_schema

explicit-trackingbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/explicit-tracking/

Create operation of resource: explicit-tracking

explicit-tracking_schema

explicit-trackingbody object

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/explicit-tracking/

Delete operation of resource: explicit-tracking

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/vrfs/vrf/{vrf-name}/interfaces/interface/{interface-name}/explicit-tracking/

Retrieve operation of resource: explicit-tracking

vrf-name: string
in path

ID of vrf-name

interface-name: string
in path

ID of interface-name

200 OK
explicit-tracking_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}

DEFAULT-CONTEXT - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/

Update operation of resource: default-context

default-context_schema

default-contextbody object

Request Content-Types: application/json
Request Example
{
  : {
Default ContextPUTPOSTDELETEGET
    : {
Inheritable DefaultsPUTPOSTDELETEGET
      
"access-group": "string", Access list specifying access group range
      : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
        
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

        
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        
"access-list-name": "string" Access-list to account for

      },
      : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
        
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

        
"access-list-name": "string" Access-list to account for

      },
      
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

      
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

      
"version": "integer", Version number
range: "1..3"
default: "3"

      
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

      
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

    },
    : {
Configure IGMP QoS shapers for subscriber\ninterfacesPUTPOSTDELETEGET
      
"download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"

      
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"

      
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"

    },
    : {
IGMP Source specific modePUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"access-list-name": "string", Access-list to account for

          
"source-address": "string" IP source address

        }
      ]
    },
    
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

    
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
    : {
Configure IGMP State LimitsPUTPOSTDELETEGET
      
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    },
    : {
Configure NSF specific optionsPUTPOSTDELETEGET
      
"lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"

    },
    : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
      
"profile": "string" Configure the route-policy profile

    },
    : {
Configure IGMP accounting for logging\njoin/leave recordsPUTPOSTDELETEGET
      
"max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"

    },
    : {
Interface-level configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"access-group": "string", Access list specifying access group range

          
"interface-name": "string", Name of the interface
          : {
IGMP join multicast groupPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-address": "string", IP group address

                
"mode": "string" Filter mode

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-address": "string", IP group address

                
"mode": "string", Filter mode

                
"source-address": "string" IP source address

              }
            ]
          },
          : {
IGMP static multicast groupPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"group-address-mask": "string", Mask for Group Address

                
"group-address": "string", IP group address

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"source-address": "string", IP source address

                
"group-address-mask": "string", Mask for Group Address

                
"source-address-mask": "string", Mask for Source Address

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"group-address": "string", IP group address

                
"source-address": "string", IP source address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"source-address": "string", IP source address

                
"group-address-mask": "string", Mask for Group Address

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"source-address": "string", IP source address

                
"source-address-mask": "string", Mask for Source Address

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ]
          },
          
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
          : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
            
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

            
"access-list-name": "string" Access-list to account for

          },
          
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
          : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
            
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

            
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

            
"access-list-name": "string" Access-list to account for

          },
          
"version": "integer", Version number
range: "1..3"
default: "3"

          
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

          
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-CONTEXT - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/

Create operation of resource: default-context

default-context_schema

default-contextbody object

Request Content-Types: application/json
Request Example
{
  : {
Default ContextPUTPOSTDELETEGET
    : {
Inheritable DefaultsPUTPOSTDELETEGET
      
"access-group": "string", Access list specifying access group range
      : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
        
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

        
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        
"access-list-name": "string" Access-list to account for

      },
      : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
        
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

        
"access-list-name": "string" Access-list to account for

      },
      
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

      
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

      
"version": "integer", Version number
range: "1..3"
default: "3"

      
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

      
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

    },
    : {
Configure IGMP QoS shapers for subscriber\ninterfacesPUTPOSTDELETEGET
      
"download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"

      
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"

      
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"

    },
    : {
IGMP Source specific modePUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"access-list-name": "string", Access-list to account for

          
"source-address": "string" IP source address

        }
      ]
    },
    
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

    
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
    : {
Configure IGMP State LimitsPUTPOSTDELETEGET
      
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    },
    : {
Configure NSF specific optionsPUTPOSTDELETEGET
      
"lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"

    },
    : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
      
"profile": "string" Configure the route-policy profile

    },
    : {
Configure IGMP accounting for logging\njoin/leave recordsPUTPOSTDELETEGET
      
"max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"

    },
    : {
Interface-level configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"access-group": "string", Access list specifying access group range

          
"interface-name": "string", Name of the interface
          : {
IGMP join multicast groupPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-address": "string", IP group address

                
"mode": "string" Filter mode

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-address": "string", IP group address

                
"mode": "string", Filter mode

                
"source-address": "string" IP source address

              }
            ]
          },
          : {
IGMP static multicast groupPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"group-address-mask": "string", Mask for Group Address

                
"group-address": "string", IP group address

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"source-address": "string", IP source address

                
"group-address-mask": "string", Mask for Group Address

                
"source-address-mask": "string", Mask for Source Address

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"group-address": "string", IP group address

                
"source-address": "string", IP source address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"source-address": "string", IP source address

                
"group-address-mask": "string", Mask for Group Address

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"source-address": "string", IP source address

                
"source-address-mask": "string", Mask for Source Address

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ]
          },
          
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
          : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
            
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

            
"access-list-name": "string" Access-list to account for

          },
          
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
          : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
            
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

            
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

            
"access-list-name": "string" Access-list to account for

          },
          
"version": "integer", Version number
range: "1..3"
default: "3"

          
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

          
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-CONTEXT - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/

Delete operation of resource: default-context

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-CONTEXT - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/

Retrieve operation of resource: default-context

200 OK
default-context_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Default ContextPUTPOSTDELETEGET
    : {
Inheritable DefaultsPUTPOSTDELETEGET
      
"access-group": "string", Access list specifying access group range
      : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
        
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

        
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        
"access-list-name": "string" Access-list to account for

      },
      : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
        
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

        
"access-list-name": "string" Access-list to account for

      },
      
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

      
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

      
"version": "integer", Version number
range: "1..3"
default: "3"

      
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

      
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

    },
    : {
Configure IGMP QoS shapers for subscriber\ninterfacesPUTPOSTDELETEGET
      
"download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"

      
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"

      
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"

    },
    : {
IGMP Source specific modePUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"access-list-name": "string", Access-list to account for

          
"source-address": "string" IP source address

        }
      ]
    },
    
"ssmdns-query-group": "null", Enable SSM mapping using DNS Query

    
"robustness": "integer", Configure IGMP Robustness variable
range: "2..10"
default: "2"
    : {
Configure IGMP State LimitsPUTPOSTDELETEGET
      
"maximum-groups": "integer" Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    },
    : {
Configure NSF specific optionsPUTPOSTDELETEGET
      
"lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"

    },
    : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
      
"profile": "string" Configure the route-policy profile

    },
    : {
Configure IGMP accounting for logging\njoin/leave recordsPUTPOSTDELETEGET
      
"max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"

    },
    : {
Interface-level configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"access-group": "string", Access list specifying access group range

          
"interface-name": "string", Name of the interface
          : {
IGMP join multicast groupPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-address": "string", IP group address

                
"mode": "string" Filter mode

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-address": "string", IP group address

                
"mode": "string", Filter mode

                
"source-address": "string" IP source address

              }
            ]
          },
          : {
IGMP static multicast groupPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"group-address-mask": "string", Mask for Group Address

                
"group-address": "string", IP group address

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"source-address": "string", IP source address

                
"group-address-mask": "string", Mask for Group Address

                
"source-address-mask": "string", Mask for Source Address

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"group-address": "string", IP group address

                
"source-address": "string", IP source address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"source-address": "string", IP source address

                
"group-address-mask": "string", Mask for Group Address

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"source-address": "string", IP source address

                
"source-address-mask": "string", Mask for Source Address

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ],
            : [
 PUTPOSTDELETEGET
              {
                
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

                
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

                
"group-address": "string", IP group address

                
"suppress-report": "boolean" Suppress reports

              }
            ]
          },
          
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
          : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
            
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

            
"access-list-name": "string" Access-list to account for

          },
          
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
          : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
            
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

            
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

            
"access-list-name": "string" Access-list to account for

          },
          
"version": "integer", Version number
range: "1..3"
default: "3"

          
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

          
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

        }
      ]
    }
  }
}

NSF - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/nsf/

Update operation of resource: nsf

nsf_schema

nsfbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure NSF specific optionsPUTPOSTDELETEGET
    
"lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NSF - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/nsf/

Create operation of resource: nsf

nsf_schema

nsfbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure NSF specific optionsPUTPOSTDELETEGET
    
"lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NSF - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/nsf/

Delete operation of resource: nsf

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NSF - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/nsf/

Retrieve operation of resource: nsf

200 OK
nsf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure NSF specific optionsPUTPOSTDELETEGET
    
"lifetime": "integer" Maximum time for IGMP NSF mode in seconds
range: "10..3600"
units: "second"
default: "60"

  }
}

UNICAST-QOS-ADJUST - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/unicast-qos-adjust/

Update operation of resource: unicast-qos-adjust

unicast-qos-adjust_schema

unicast-qos-adjustbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP QoS shapers for subscriber\ninterfacesPUTPOSTDELETEGET
    
"download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"

    
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"

    
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UNICAST-QOS-ADJUST - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/unicast-qos-adjust/

Create operation of resource: unicast-qos-adjust

unicast-qos-adjust_schema

unicast-qos-adjustbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP QoS shapers for subscriber\ninterfacesPUTPOSTDELETEGET
    
"download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"

    
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"

    
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UNICAST-QOS-ADJUST - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/unicast-qos-adjust/

Delete operation of resource: unicast-qos-adjust

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UNICAST-QOS-ADJUST - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/unicast-qos-adjust/

Retrieve operation of resource: unicast-qos-adjust

200 OK
unicast-qos-adjust_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IGMP QoS shapers for subscriber\ninterfacesPUTPOSTDELETEGET
    
"download-interval": "integer", Configure the QoS download interval (in\nmilliseconds)
range: "10..500"
units: "millisecond"
default: "100"

    
"hold-off": "integer", Configure the QoS hold off time (in seconds)
range: "5..1800"
units: "second"
default: "180"

    
"adjustment-delay": "integer" Configure the QoS delay before programming (in\nseconds)
range: "0..10"
units: "second"
default: "1"

  }
}

ACCOUNTING - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/accounting/

Update operation of resource: accounting

accounting_schema

accountingbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP accounting for logging\njoin/leave recordsPUTPOSTDELETEGET
    
"max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCOUNTING - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/accounting/

Create operation of resource: accounting

accounting_schema

accountingbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP accounting for logging\njoin/leave recordsPUTPOSTDELETEGET
    
"max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCOUNTING - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/accounting/

Delete operation of resource: accounting

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACCOUNTING - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/accounting/

Retrieve operation of resource: accounting

200 OK
accounting_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IGMP accounting for logging\njoin/leave recordsPUTPOSTDELETEGET
    
"max-history": "integer" Configure IGMP accounting Maximum History\nsetting
range: "1..365"
units: "day"
default: "1"

  }
}

TRAFFIC - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/traffic/

Update operation of resource: traffic

traffic_schema

trafficbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
    
"profile": "string" Configure the route-policy profile

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/traffic/

Create operation of resource: traffic

traffic_schema

trafficbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
    
"profile": "string" Configure the route-policy profile

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/traffic/

Delete operation of resource: traffic

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/traffic/

Retrieve operation of resource: traffic

200 OK
traffic_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IGMP Traffic variablesPUTPOSTDELETEGET
    
"profile": "string" Configure the route-policy profile

  }
}

INHERITABLE-DEFAULTS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/inheritable-defaults/

Update operation of resource: inheritable-defaults

inheritable-defaults_schema

inheritable-defaultsbody object

Request Content-Types: application/json
Request Example
{
  : {
Inheritable DefaultsPUTPOSTDELETEGET
    
"access-group": "string", Access list specifying access group range
    : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
      
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

      
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      
"access-list-name": "string" Access list specifying tracking group range

    },
    : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
      
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

      
"access-list-name": "string" Access list specifying tracking group range

    },
    
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

    
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

    
"version": "integer", Version number
range: "1..3"
default: "3"

    
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

    
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/inheritable-defaults/

Create operation of resource: inheritable-defaults

inheritable-defaults_schema

inheritable-defaultsbody object

Request Content-Types: application/json
Request Example
{
  : {
Inheritable DefaultsPUTPOSTDELETEGET
    
"access-group": "string", Access list specifying access group range
    : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
      
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

      
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      
"access-list-name": "string" Access list specifying tracking group range

    },
    : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
      
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

      
"access-list-name": "string" Access list specifying tracking group range

    },
    
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

    
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

    
"version": "integer", Version number
range: "1..3"
default: "3"

    
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

    
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/inheritable-defaults/

Delete operation of resource: inheritable-defaults

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INHERITABLE-DEFAULTS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/inheritable-defaults/

Retrieve operation of resource: inheritable-defaults

200 OK
inheritable-defaults_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Inheritable DefaultsPUTPOSTDELETEGET
    
"access-group": "string", Access list specifying access group range
    : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
      
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

      
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

      
"access-list-name": "string" Access list specifying tracking group range

    },
    : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
      
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

      
"access-list-name": "string" Access list specifying tracking group range

    },
    
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"

    
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"

    
"version": "integer", Version number
range: "1..3"
default: "3"

    
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

    
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

  }
}

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/inheritable-defaults/maximum-groups-per-interface-oor/

Update operation of resource: maximum-groups-per-interface-oor

maximum-groups-per-interface-oor_schema

maximum-groups-per-interface-oorbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/inheritable-defaults/maximum-groups-per-interface-oor/

Create operation of resource: maximum-groups-per-interface-oor

maximum-groups-per-interface-oor_schema

maximum-groups-per-interface-oorbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/inheritable-defaults/maximum-groups-per-interface-oor/

Delete operation of resource: maximum-groups-per-interface-oor

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/inheritable-defaults/maximum-groups-per-interface-oor/

Retrieve operation of resource: maximum-groups-per-interface-oor

200 OK
maximum-groups-per-interface-oor_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}

EXPLICIT-TRACKING - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/inheritable-defaults/explicit-tracking/

Update operation of resource: explicit-tracking

explicit-tracking_schema

explicit-trackingbody object

Request Content-Types: application/json
Request Example
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/inheritable-defaults/explicit-tracking/

Create operation of resource: explicit-tracking

explicit-tracking_schema

explicit-trackingbody object

Request Content-Types: application/json
Request Example
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/inheritable-defaults/explicit-tracking/

Delete operation of resource: explicit-tracking

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/inheritable-defaults/explicit-tracking/

Retrieve operation of resource: explicit-tracking

200 OK
explicit-tracking_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}

SSM-ACCESS-GROUPS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/ssm-access-groups/

Update operation of resource: ssm-access-groups

ssm-access-groups_schema

ssm-access-groupsbody object

Request Content-Types: application/json
Request Example
{
  : {
IGMP Source specific modePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-list-name": "string", Access list specifying access group

        
"source-address": "string" IP source address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUPS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/ssm-access-groups/

Create operation of resource: ssm-access-groups

ssm-access-groups_schema

ssm-access-groupsbody object

Request Content-Types: application/json
Request Example
{
  : {
IGMP Source specific modePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-list-name": "string", Access list specifying access group

        
"source-address": "string" IP source address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUPS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/ssm-access-groups/

Delete operation of resource: ssm-access-groups

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUPS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/ssm-access-groups/

Retrieve operation of resource: ssm-access-groups

200 OK
ssm-access-groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMP Source specific modePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-list-name": "string", Access list specifying access group

        
"source-address": "string" IP source address

      }
    ]
  }
}

SSM-ACCESS-GROUP - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/ssm-access-groups/ssm-access-group/{source-address}/

Update operation of resource: ssm-access-group

ssm-access-group_schema

ssm-access-groupbody object

source-address: string
in path

ID of source-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-list-name": "string", Access list specifying access group

      
"source-address": "string" IP source address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUP - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/ssm-access-groups/ssm-access-group/{source-address}/

Create operation of resource: ssm-access-group

ssm-access-group_schema

ssm-access-groupbody object

source-address: string
in path

ID of source-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-list-name": "string", Access list specifying access group

      
"source-address": "string" IP source address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUP - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/ssm-access-groups/ssm-access-group/{source-address}/

Delete operation of resource: ssm-access-group

source-address: string
in path

ID of source-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SSM-ACCESS-GROUP - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/ssm-access-groups/ssm-access-group/{source-address}/

Retrieve operation of resource: ssm-access-group

source-address: string
in path

ID of source-address

200 OK
ssm-access-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-list-name": "string", Access list specifying access group

      
"source-address": "string" IP source address

    }
  ]
}

MAXIMUM - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/maximum/

Update operation of resource: maximum

maximum_schema

maximumbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP State LimitsPUTPOSTDELETEGET
    
"maximum-groups": "integer" Configure maximum number of groups accepted by\nthis router
range: "1..40000"
default: "50000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/maximum/

Create operation of resource: maximum

maximum_schema

maximumbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IGMP State LimitsPUTPOSTDELETEGET
    
"maximum-groups": "integer" Configure maximum number of groups accepted by\nthis router
range: "1..40000"
default: "50000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/maximum/

Delete operation of resource: maximum

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/maximum/

Retrieve operation of resource: maximum

200 OK
maximum_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IGMP State LimitsPUTPOSTDELETEGET
    
"maximum-groups": "integer" Configure maximum number of groups accepted by\nthis router
range: "1..40000"
default: "50000"

  }
}

INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/

Update operation of resource: interfaces

interfaces_schema

interfacesbody object

Request Content-Types: application/json
Request Example
{
  : {
Interface-level configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-group": "string", Access list specifying access group range

        
"interface-name": "string", Name of the interface
        : {
IGMP join multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string" Filter mode

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string", Filter mode

              
"source-address": "string" IP source address

            }
          ]
        },
        : {
IGMP static multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"source-address": "string", IP source address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ]
        },
        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/

Create operation of resource: interfaces

interfaces_schema

interfacesbody object

Request Content-Types: application/json
Request Example
{
  : {
Interface-level configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-group": "string", Access list specifying access group range

        
"interface-name": "string", Name of the interface
        : {
IGMP join multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string" Filter mode

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string", Filter mode

              
"source-address": "string" IP source address

            }
          ]
        },
        : {
IGMP static multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"source-address": "string", IP source address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ]
        },
        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/

Delete operation of resource: interfaces

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/

Retrieve operation of resource: interfaces

200 OK
interfaces_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Interface-level configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"access-group": "string", Access list specifying access group range

        
"interface-name": "string", Name of the interface
        : {
IGMP join multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string" Filter mode

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-address": "string", IP group address

              
"mode": "string", Filter mode

              
"source-address": "string" IP source address

            }
          ]
        },
        : {
IGMP static multicast groupPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"source-address": "string", IP source address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"group-address-mask": "string", Mask for Group Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"source-address": "string", IP source address

              
"source-address-mask": "string", Mask for Source Address

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ],
          : [
 PUTPOSTDELETEGET
            {
              
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

              
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

              
"group-address": "string", IP group address

              
"suppress-report": "boolean" Suppress reports

            }
          ]
        },
        
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
        : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
          
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

          
"access-list-name": "string" Access-list to account for

        },
        
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
        : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
          
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

          
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

          
"access-list-name": "string" Access-list to account for

        },
        
"version": "integer", Version number
range: "1..3"
default: "3"

        
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

        
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

      }
    ]
  }
}

INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/

Update operation of resource: interface

interface_schema

interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-group": "string", Access list specifying access group range

      
"interface-name": "string", Name of the interface
      : {
IGMP join multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string" Filter mode

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string", Filter mode

            
"source-address": "string" IP source address

          }
        ]
      },
      : {
IGMP static multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"source-address": "string", IP source address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ]
      },
      
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
      : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
        
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

        
"access-list-name": "string" Access-list to account for

      },
      
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
      : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
        
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

        
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        
"access-list-name": "string" Access-list to account for

      },
      
"version": "integer", Version number
range: "1..3"
default: "3"

      
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

      
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/

Create operation of resource: interface

interface_schema

interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-group": "string", Access list specifying access group range

      
"interface-name": "string", Name of the interface
      : {
IGMP join multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string" Filter mode

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string", Filter mode

            
"source-address": "string" IP source address

          }
        ]
      },
      : {
IGMP static multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"source-address": "string", IP source address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ]
      },
      
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
      : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
        
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

        
"access-list-name": "string" Access-list to account for

      },
      
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
      : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
        
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

        
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        
"access-list-name": "string" Access-list to account for

      },
      
"version": "integer", Version number
range: "1..3"
default: "3"

      
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

      
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/

Delete operation of resource: interface

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/

Retrieve operation of resource: interface

interface-name: string
in path

ID of interface-name

200 OK
interface_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"access-group": "string", Access list specifying access group range

      
"interface-name": "string", Name of the interface
      : {
IGMP join multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string" Filter mode

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-address": "string", IP group address

            
"mode": "string", Filter mode

            
"source-address": "string" IP source address

          }
        ]
      },
      : {
IGMP static multicast groupPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"source-address": "string", IP source address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"group-address-mask": "string", Mask for Group Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"source-address": "string", IP source address

            
"source-address-mask": "string", Mask for Source Address

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ],
        : [
 PUTPOSTDELETEGET
          {
            
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

            
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

            
"group-address": "string", IP group address

            
"suppress-report": "boolean" Suppress reports

          }
        ]
      },
      
"query-interval": "integer", Query interval in seconds
range: "1..3600"
units: "second"
default: "60"
      : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
        
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

        
"access-list-name": "string" Access-list to account for

      },
      
"query-timeout": "integer", IGMP previous querier timeout
range: "60..300"
units: "second"
      : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
        
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

        
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

        
"access-list-name": "string" Access-list to account for

      },
      
"version": "integer", Version number
range: "1..3"
default: "3"

      
"query-max-response-time": "integer", Query response value in seconds
range: "1..12"
units: "second"
default: "10"

      
"router-enable": "boolean" Enabled or disabled, when value is TRUE or FALSE\nrespectively

    }
  ]
}

JOIN-GROUPS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/join-groups/

Update operation of resource: join-groups

join-groups_schema

join-groupsbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP join multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string" Filter mode

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string", Filter mode

        
"source-address": "string" Optional IP source address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUPS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/join-groups/

Create operation of resource: join-groups

join-groups_schema

join-groupsbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP join multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string" Filter mode

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string", Filter mode

        
"source-address": "string" Optional IP source address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUPS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/join-groups/

Delete operation of resource: join-groups

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUPS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/join-groups/

Retrieve operation of resource: join-groups

interface-name: string
in path

ID of interface-name

200 OK
join-groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMP join multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string" Filter mode

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-address": "string", IP group address

        
"mode": "string", Filter mode

        
"source-address": "string" Optional IP source address

      }
    ]
  }
}

JOIN-GROUP - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/join-groups/join-group/{group-address}/

Update operation of resource: join-group

join-group_schema

join-groupbody object

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string" Filter mode

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string", Filter mode

      
"source-address": "string" Optional IP source address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/join-groups/join-group/{group-address}/

Create operation of resource: join-group

join-group_schema

join-groupbody object

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string" Filter mode

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string", Filter mode

      
"source-address": "string" Optional IP source address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/join-groups/join-group/{group-address}/

Delete operation of resource: join-group

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/join-groups/join-group/{group-address}/

Retrieve operation of resource: join-group

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

200 OK
join-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string" Filter mode

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-address": "string", IP group address

      
"mode": "string", Filter mode

      
"source-address": "string" Optional IP source address

    }
  ]
}

JOIN-GROUP-SOURCE-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/join-groups/join-group-source-address/{group-address source-address}/

Update operation of resource: join-group-source-address

join-group-source-address_schema

join-group-source-addressbody object

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-address": "string", IP group address

    
"mode": "string", Filter mode

    
"source-address": "string" Optional IP source address

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP-SOURCE-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/join-groups/join-group-source-address/{group-address source-address}/

Create operation of resource: join-group-source-address

join-group-source-address_schema

join-group-source-addressbody object

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-address": "string", IP group address

    
"mode": "string", Filter mode

    
"source-address": "string" Optional IP source address

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP-SOURCE-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/join-groups/join-group-source-address/{group-address source-address}/

Delete operation of resource: join-group-source-address

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JOIN-GROUP-SOURCE-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/join-groups/join-group-source-address/{group-address source-address}/

Retrieve operation of resource: join-group-source-address

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

200 OK
join-group-source-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-address": "string", IP group address

    
"mode": "string", Filter mode

    
"source-address": "string" Optional IP source address

  }
}

STATIC-GROUP-GROUP-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/

Update operation of resource: static-group-group-addresses

static-group-group-addresses_schema

static-group-group-addressesbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP static multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"source-address": "string", IP source address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/

Create operation of resource: static-group-group-addresses

static-group-group-addresses_schema

static-group-group-addressesbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMP static multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"source-address": "string", IP source address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/

Delete operation of resource: static-group-group-addresses

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/

Retrieve operation of resource: static-group-group-addresses

interface-name: string
in path

ID of interface-name

200 OK
static-group-group-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMP static multicast groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"source-address": "string", IP source address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"group-address-mask": "string", Mask for Group Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"source-address": "string", IP source address

        
"source-address-mask": "string", Mask for Source Address

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ],
    : [
 PUTPOSTDELETEGET
      {
        
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

        
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

        
"group-address": "string", IP group address

        
"suppress-report": "boolean" Suppress reports

      }
    ]
  }
}

STATIC-GROUP-GROUP-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address/{group-address}/

Update operation of resource: static-group-group-address

static-group-group-address_schema

static-group-group-addressbody object

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"source-address": "string", IP source address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address/{group-address}/

Create operation of resource: static-group-group-address

static-group-group-address_schema

static-group-group-addressbody object

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"source-address": "string", IP source address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address/{group-address}/

Delete operation of resource: static-group-group-address

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address/{group-address}/

Retrieve operation of resource: static-group-group-address

interface-name: string
in path

ID of interface-name

group-address: string
in path

ID of group-address

200 OK
static-group-group-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"source-address": "string", IP source address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"group-address-mask": "string", Mask for Group Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"source-address": "string", IP source address

      
"source-address-mask": "string", Mask for Source Address

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ],
  : [
 PUTPOSTDELETEGET
    {
      
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

      
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

      
"group-address": "string", IP group address

      
"suppress-report": "boolean" Suppress reports

    }
  ]
}

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address/{group-address source-address}/

Update operation of resource: static-group-group-address-source-address

static-group-group-address-source-address_schema

static-group-group-address-source-addressbody object

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"group-address": "string", IP group address

    
"source-address": "string", IP source address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address/{group-address source-address}/

Create operation of resource: static-group-group-address-source-address

static-group-group-address-source-address_schema

static-group-group-address-source-addressbody object

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"group-address": "string", IP group address

    
"source-address": "string", IP source address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address/{group-address source-address}/

Delete operation of resource: static-group-group-address-source-address

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address/{group-address source-address}/

Retrieve operation of resource: static-group-group-address-source-address

interface-name: string
in path

ID of interface-name

group-address source-address: string
in path

ID of group-address source-address

200 OK
static-group-group-address-source-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"group-address": "string", IP group address

    
"source-address": "string", IP source address

    
"suppress-report": "boolean" Suppress reports

  }
}

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address-source-address-mask/{group-address source-address source-address-mask}/

Update operation of resource: static-group-group-address-source-address-source-address-mask

static-group-group-address-source-address-source-address-mask_schema

static-group-group-address-source-address-source-address-maskbody object

interface-name: string
in path

ID of interface-name

group-address source-address source-address-mask: string
in path

ID of group-address source-address source-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address-source-address-mask/{group-address source-address source-address-mask}/

Create operation of resource: static-group-group-address-source-address-source-address-mask

static-group-group-address-source-address-source-address-mask_schema

static-group-group-address-source-address-source-address-maskbody object

interface-name: string
in path

ID of interface-name

group-address source-address source-address-mask: string
in path

ID of group-address source-address source-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address-source-address-mask/{group-address source-address source-address-mask}/

Delete operation of resource: static-group-group-address-source-address-source-address-mask

interface-name: string
in path

ID of interface-name

group-address source-address source-address-mask: string
in path

ID of group-address source-address source-address-mask

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-source-address-source-address-mask/{group-address source-address source-address-mask}/

Retrieve operation of resource: static-group-group-address-source-address-source-address-mask

interface-name: string
in path

ID of interface-name

group-address source-address source-address-mask: string
in path

ID of group-address source-address source-address-mask

200 OK
static-group-group-address-source-address-source-address-mask_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask/{group-address group-address-mask}/

Update operation of resource: static-group-group-address-group-address-mask

static-group-group-address-group-address-mask_schema

static-group-group-address-group-address-maskbody object

interface-name: string
in path

ID of interface-name

group-address group-address-mask: string
in path

ID of group-address group-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask/{group-address group-address-mask}/

Create operation of resource: static-group-group-address-group-address-mask

static-group-group-address-group-address-mask_schema

static-group-group-address-group-address-maskbody object

interface-name: string
in path

ID of interface-name

group-address group-address-mask: string
in path

ID of group-address group-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask/{group-address group-address-mask}/

Delete operation of resource: static-group-group-address-group-address-mask

interface-name: string
in path

ID of interface-name

group-address group-address-mask: string
in path

ID of group-address group-address-mask

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask/{group-address group-address-mask}/

Retrieve operation of resource: static-group-group-address-group-address-mask

interface-name: string
in path

ID of interface-name

group-address group-address-mask: string
in path

ID of group-address group-address-mask

200 OK
static-group-group-address-group-address-mask_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"suppress-report": "boolean" Suppress reports

  }
}

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address/{group-address group-address-mask source-address}/

Update operation of resource: static-group-group-address-group-address-mask-source-address

static-group-group-address-group-address-mask-source-address_schema

static-group-group-address-group-address-mask-source-addressbody object

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address: string
in path

ID of group-address group-address-mask source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address/{group-address group-address-mask source-address}/

Create operation of resource: static-group-group-address-group-address-mask-source-address

static-group-group-address-group-address-mask-source-address_schema

static-group-group-address-group-address-mask-source-addressbody object

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address: string
in path

ID of group-address group-address-mask source-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address/{group-address group-address-mask source-address}/

Delete operation of resource: static-group-group-address-group-address-mask-source-address

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address: string
in path

ID of group-address group-address-mask source-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address/{group-address group-address-mask source-address}/

Retrieve operation of resource: static-group-group-address-group-address-mask-source-address

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address: string
in path

ID of group-address group-address-mask source-address

200 OK
static-group-group-address-group-address-mask-source-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address-source-address-mask/{group-address group-address-mask source-address source-address-mask}/

Update operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask

static-group-group-address-group-address-mask-source-address-source-address-mask_schema

static-group-group-address-group-address-mask-source-address-source-address-maskbody object

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address source-address-mask: string
in path

ID of group-address group-address-mask source-address source-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address-source-address-mask/{group-address group-address-mask source-address source-address-mask}/

Create operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask

static-group-group-address-group-address-mask-source-address-source-address-mask_schema

static-group-group-address-group-address-mask-source-address-source-address-maskbody object

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address source-address-mask: string
in path

ID of group-address group-address-mask source-address source-address-mask

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address-source-address-mask/{group-address group-address-mask source-address source-address-mask}/

Delete operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address source-address-mask: string
in path

ID of group-address group-address-mask source-address source-address-mask

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-GROUP-GROUP-ADDRESS-GROUP-ADDRESS-MASK-SOURCE-ADDRESS-SOURCE-ADDRESS-MASK - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/static-group-group-addresses/static-group-group-address-group-address-mask-source-address-source-address-mask/{group-address group-address-mask source-address source-address-mask}/

Retrieve operation of resource: static-group-group-address-group-address-mask-source-address-source-address-mask

interface-name: string
in path

ID of interface-name

group-address group-address-mask source-address source-address-mask: string
in path

ID of group-address group-address-mask source-address source-address-mask

200 OK
static-group-group-address-group-address-mask-source-address-source-address-mask_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"group-count": "integer", Number of groups to join (do not set without\nGroupAddressMask)
range: "1..512"
default: "1"

    
"source-count": "integer", Number of sources to join (do not set\nwithout SourceAddressMask)
range: "1..512"
default: "1"

    
"source-address": "string", IP source address

    
"group-address-mask": "string", Mask for Group Address

    
"source-address-mask": "string", Mask for Source Address

    
"group-address": "string", IP group address

    
"suppress-report": "boolean" Suppress reports

  }
}

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/maximum-groups-per-interface-oor/

Update operation of resource: maximum-groups-per-interface-oor

maximum-groups-per-interface-oor_schema

maximum-groups-per-interface-oorbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/maximum-groups-per-interface-oor/

Create operation of resource: maximum-groups-per-interface-oor

maximum-groups-per-interface-oor_schema

maximum-groups-per-interface-oorbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/maximum-groups-per-interface-oor/

Delete operation of resource: maximum-groups-per-interface-oor

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAXIMUM-GROUPS-PER-INTERFACE-OOR - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/maximum-groups-per-interface-oor/

Retrieve operation of resource: maximum-groups-per-interface-oor

interface-name: string
in path

ID of interface-name

200 OK
maximum-groups-per-interface-oor_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure maximum number of groups accepted per\ninterface by this routerPUTPOSTDELETEGET
    
"warning-threshold": "integer",  WarningThreshold for number of groups accepted\nper interface by this router
range: "1..40000"
default: "25000"

    
"maximum-groups": "integer", Maximum number of groups accepted per interface\nby this router
range: "1..40000"
default: "50000"

    
"access-list-name": "string" Access-list to account for

  }
}

EXPLICIT-TRACKING - Update

PUT Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/explicit-tracking/

Update operation of resource: explicit-tracking

explicit-tracking_schema

explicit-trackingbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Create

POST Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/explicit-tracking/

Create operation of resource: explicit-tracking

explicit-tracking_schema

explicit-trackingbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Delete

DELETE Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/explicit-tracking/

Delete operation of resource: explicit-tracking

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EXPLICIT-TRACKING - Retrieve

GET Cisco-IOS-XR-ipv4-igmp-cfg:mld/default-context/interfaces/interface/{interface-name}/explicit-tracking/

Retrieve operation of resource: explicit-tracking

interface-name: string
in path

ID of interface-name

200 OK
explicit-tracking_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IGMPv3 explicit host trackingPUTPOSTDELETEGET
    
"enable": "boolean", Enabled or disabled, when value is TRUE or\nFALSE respectively

    
"access-list-name": "string" Access list specifying tracking group range

  }
}